René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Obscure error message `ValueError: Request obj does not match any template` when required field is not provided","articleBody":"In PR https://github.com/googleapis/python-compute/pull/147, I had to apply [this change](https://github.com/googleapis/python-compute/pull/147/commits/e955cc63b4bf30ea84114ebb23a160a0f2b8da83) to the samples tests because a required field `usage_export_location_resource ` was not provided. I've opened this issue because the error message `ValueError: Request obj does not match any template` could be improved. We should provide more information to help users debug the issue as I found it difficult to find the root cause.\r\n\r\nSee build log [here](https://source.cloud.google.com/results/invocations/b22865c2-86f5-4ac8-bc14-feac78dcb9fd/log) and stack trace below.\r\n```\r\n=================================== FAILURES ===================================\r\n_____________________ test_set_usage_export_bucket_default _____________________\r\n\r\ncapsys = \u003c_pytest.capture.CaptureFixture object at 0x7fee8a8dd690\u003e\r\ntemp_bucket = \u003cBucket: teste4bc9ab375\u003e\r\n\r\n    def test_set_usage_export_bucket_default(capsys: typing.Any,\r\n                                             temp_bucket: storage.Bucket) -\u003e None:\r\n        set_usage_export_bucket(project_id=PROJECT, bucket_name=temp_bucket.name)\r\n        time.sleep(5)  # To make sure the settings are properly updated\r\n        uel = get_usage_export_bucket(project_id=PROJECT)\r\n        assert(uel.bucket_name == temp_bucket.name)\r\n        assert(uel.report_name_prefix == 'usage_gce')\r\n        out, _ = capsys.readouterr()\r\n        assert('default prefix of `usage_gce`.' in out)\r\n\r\n\u003e       disable_usage_export(project_id=PROJECT)\r\n\r\ntest_sample_default_values.py:48:\r\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\r\nsample_default_values.py:118: in disable_usage_export\r\n    project=project_id, usage_export_location_resource=None)\r\n../../google/cloud/compute_v1/services/projects/client.py:1399: in set_usage_export_bucket\r\n    response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)\r\n.nox/py-3-7/lib/python3.7/site-packages/google/api_core/gapic_v1/method.py:154: in __call__\r\n    return wrapped_func(*args, **kwargs)\r\n.nox/py-3-7/lib/python3.7/site-packages/google/api_core/grpc_helpers.py:66: in error_remapped_callable\r\n    return callable_(*args, **kwargs)\r\n../../google/cloud/compute_v1/services/projects/transports/rest.py:1352: in _set_usage_export_bucket\r\n    transcoded_request = path_template.transcode(http_options, **request_kwargs)\r\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\r\n\r\nhttp_options = [{'body': 'usage_export_location_resource', 'method': 'post', 'uri': '/compute/v1/projects/{project}/setUsageExportBucket'}]\r\nrequest_kwargs = {'project': 'python-docs-samples-tests-py37'}\r\nhttp_option = {'body': 'usage_export_location_resource', 'method': 'post', 'uri': '/compute/v1/projects/{project}/setUsageExportBucket'}\r\nrequest = {'uri': '/compute/v1/projects/python-docs-samples-tests-py37/setUsageExportBucket'}\r\nuri_template = '/compute/v1/projects/{project}/setUsageExportBucket'\r\npath_fields = ['project']\r\npath_args = {'project': 'python-docs-samples-tests-py37'}, leftovers = {}\r\npath_field = 'project'\r\n\r\n    def transcode(http_options, **request_kwargs):\r\n        \"\"\"Transcodes a grpc request pattern into a proper HTTP request following the rules outlined here,\r\n           https://github.com/googleapis/googleapis/blob/master/google/api/http.proto#L44-L312\r\n\r\n            Args:\r\n                http_options (list(dict)): A list of dicts which consist of these keys,\r\n                    'method'    (str): The http method\r\n                    'uri'       (str): The path template\r\n                    'body'      (str): The body field name (optional)\r\n                    (This is a simplified representation of the proto option `google.api.http`)\r\n\r\n                request_kwargs (dict) : A dict representing the request object\r\n\r\n            Returns:\r\n                dict: The transcoded request with these keys,\r\n                    'method'        (str)   : The http method\r\n                    'uri'           (str)   : The expanded uri\r\n                    'body'          (dict)  : A dict representing the body (optional)\r\n                    'query_params'  (dict)  : A dict mapping query parameter variables and values\r\n\r\n            Raises:\r\n                ValueError: If the request does not match the given template.\r\n        \"\"\"\r\n        for http_option in http_options:\r\n            request = {}\r\n\r\n            # Assign path\r\n            uri_template = http_option[\"uri\"]\r\n            path_fields = [\r\n                match.group(\"name\") for match in _VARIABLE_RE.finditer(uri_template)\r\n            ]\r\n            path_args = {field: get_field(request_kwargs, field) for field in path_fields}\r\n            request[\"uri\"] = expand(uri_template, **path_args)\r\n\r\n            # Remove fields used in uri path from request\r\n            leftovers = copy.deepcopy(request_kwargs)\r\n            for path_field in path_fields:\r\n                delete_field(leftovers, path_field)\r\n\r\n            if not validate(uri_template, request[\"uri\"]) or not all(path_args.values()):\r\n                continue\r\n\r\n            # Assign body and query params\r\n            body = http_option.get(\"body\")\r\n\r\n            if body:\r\n                if body == \"*\":\r\n                    request[\"body\"] = leftovers\r\n                    request[\"query_params\"] = {}\r\n                else:\r\n                    try:\r\n                        request[\"body\"] = leftovers.pop(body)\r\n                    except KeyError:\r\n                        continue\r\n                    request[\"query_params\"] = leftovers\r\n            else:\r\n                request[\"query_params\"] = leftovers\r\n            request[\"method\"] = http_option[\"method\"]\r\n            return request\r\n\r\n\u003e       raise ValueError(\"Request obj does not match any template\")\r\nE       ValueError: Request obj does not match any template\r\n\r\n.nox/py-3-7/lib/python3.7/site-packages/google/api_core/path_template.py:300: ValueError\r\n_____________________ test_set_usage_export_bucket_custom ______________________\r\n\r\ncapsys = \u003c_pytest.capture.CaptureFixture object at 0x7fee8a74ba90\u003e\r\ntemp_bucket = \u003cBucket: teste4bc9ab375\u003e\r\n\r\n    def test_set_usage_export_bucket_custom(capsys: typing.Any,\r\n                                            temp_bucket: storage.Bucket) -\u003e None:\r\n        set_usage_export_bucket(project_id=PROJECT, bucket_name=temp_bucket.name,\r\n                                report_name_prefix=TEST_PREFIX)\r\n        time.sleep(5)  # To make sure the settings are properly updated\r\n        uel = get_usage_export_bucket(project_id=PROJECT)\r\n        assert(uel.bucket_name == temp_bucket.name)\r\n        assert(uel.report_name_prefix == TEST_PREFIX)\r\n        out, _ = capsys.readouterr()\r\n        assert('usage_gce' not in out)\r\n\r\n\u003e       disable_usage_export(project_id=PROJECT)\r\n\r\ntest_sample_default_values.py:66:\r\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\r\nsample_default_values.py:118: in disable_usage_export\r\n    project=project_id, usage_export_location_resource=None)\r\n../../google/cloud/compute_v1/services/projects/client.py:1399: in set_usage_export_bucket\r\n    response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)\r\n.nox/py-3-7/lib/python3.7/site-packages/google/api_core/gapic_v1/method.py:154: in __call__\r\n    return wrapped_func(*args, **kwargs)\r\n.nox/py-3-7/lib/python3.7/site-packages/google/api_core/grpc_helpers.py:66: in error_remapped_callable\r\n    return callable_(*args, **kwargs)\r\n../../google/cloud/compute_v1/services/projects/transports/rest.py:1352: in _set_usage_export_bucket\r\n    transcoded_request = path_template.transcode(http_options, **request_kwargs)\r\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\r\n\r\nhttp_options = [{'body': 'usage_export_location_resource', 'method': 'post', 'uri': '/compute/v1/projects/{project}/setUsageExportBucket'}]\r\nrequest_kwargs = {'project': 'python-docs-samples-tests-py37'}\r\nhttp_option = {'body': 'usage_export_location_resource', 'method': 'post', 'uri': '/compute/v1/projects/{project}/setUsageExportBucket'}\r\nrequest = {'uri': '/compute/v1/projects/python-docs-samples-tests-py37/setUsageExportBucket'}\r\nuri_template = '/compute/v1/projects/{project}/setUsageExportBucket'\r\npath_fields = ['project']\r\npath_args = {'project': 'python-docs-samples-tests-py37'}, leftovers = {}\r\npath_field = 'project'\r\n\r\n    def transcode(http_options, **request_kwargs):\r\n        \"\"\"Transcodes a grpc request pattern into a proper HTTP request following the rules outlined here,\r\n           https://github.com/googleapis/googleapis/blob/master/google/api/http.proto#L44-L312\r\n\r\n            Args:\r\n                http_options (list(dict)): A list of dicts which consist of these keys,\r\n                    'method'    (str): The http method\r\n                    'uri'       (str): The path template\r\n                    'body'      (str): The body field name (optional)\r\n                    (This is a simplified representation of the proto option `google.api.http`)\r\n\r\n                request_kwargs (dict) : A dict representing the request object\r\n\r\n            Returns:\r\n                dict: The transcoded request with these keys,\r\n                    'method'        (str)   : The http method\r\n                    'uri'           (str)   : The expanded uri\r\n                    'body'          (dict)  : A dict representing the body (optional)\r\n                    'query_params'  (dict)  : A dict mapping query parameter variables and values\r\n\r\n            Raises:\r\n                ValueError: If the request does not match the given template.\r\n        \"\"\"\r\n        for http_option in http_options:\r\n            request = {}\r\n\r\n            # Assign path\r\n            uri_template = http_option[\"uri\"]\r\n            path_fields = [\r\n                match.group(\"name\") for match in _VARIABLE_RE.finditer(uri_template)\r\n            ]\r\n            path_args = {field: get_field(request_kwargs, field) for field in path_fields}\r\n            request[\"uri\"] = expand(uri_template, **path_args)\r\n\r\n            # Remove fields used in uri path from request\r\n            leftovers = copy.deepcopy(request_kwargs)\r\n            for path_field in path_fields:\r\n                delete_field(leftovers, path_field)\r\n\r\n            if not validate(uri_template, request[\"uri\"]) or not all(path_args.values()):\r\n                continue\r\n\r\n            # Assign body and query params\r\n            body = http_option.get(\"body\")\r\n\r\n            if body:\r\n                if body == \"*\":\r\n                    request[\"body\"] = leftovers\r\n                    request[\"query_params\"] = {}\r\n                else:\r\n                    try:\r\n                        request[\"body\"] = leftovers.pop(body)\r\n                    except KeyError:\r\n                        continue\r\n                    request[\"query_params\"] = leftovers\r\n            else:\r\n                request[\"query_params\"] = leftovers\r\n            request[\"method\"] = http_option[\"method\"]\r\n            return request\r\n\r\n\u003e       raise ValueError(\"Request obj does not match any template\")\r\nE       ValueError: Request obj does not match any template\r\n\r\n.nox/py-3-7/lib/python3.7/site-packages/google/api_core/path_template.py:300: ValueError\r\n```\r\n\r\n","author":{"url":"https://github.com/parthea","@type":"Person","name":"parthea"},"datePublished":"2021-11-12T17:30:40.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/327/python-api-core/issues/327"}