Python 2.7 has reached end of support
and will be
deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their
deprecation date. We recommend that
you
migrate to the latest supported version of Python.
Stay organized with collections
Save and categorize content based on your preferences.
google.appengine.api.client_deployinfo module
Summary
Client deploy info.
Library for parsing client_deploy.yaml files and working with these in memory.
Contents
- class google.appengine.api.client_deployinfo.ClientDeployInfoExternal(**attributes)source
-
Bases: google.appengine.api.validation.Validated
Describes the format of a client_deployinfo.yaml file.
- ATTRIBUTES = {'start_time_usec': <google.appengine.api.validation.Type object>, 'end_time_usec': <google.appengine.api.validation.Type object>, 'success': <google.appengine.api.validation.Type object>, 'sdk_version': <google.appengine.api.validation.Optional object>, 'requests': <google.appengine.api.validation.Optional object>, 'runtime': '((gs://[a-z0-9\\-\\._/]+)|([a-z][a-z0-9\\-\\.]{0,29}))'}
- exception google.appengine.api.client_deployinfo.Errorsource
-
Bases: exceptions.Exception
Base ClientDeployInfo Exception type.
- google.appengine.api.client_deployinfo.LoadSingleClientDeployInfo(client_deploy_info)source
Returns a ClientDeployInfoExternal from a deploy_info.yaml file or string.
Parametersclient_deploy_info – The contents of a client_deploy_info.yaml file or
string, or an open file object.
ReturnsA ClientDeployInfoExternal instance which represents the contents of the
parsed yaml.
Raises
-
EmptyYaml – when there are no documents in yaml.
-
MultipleClientDeployInfo – when there are multiple documents in yaml.
-
yaml_errors.EventError – when an error occurs while parsing the yaml.
- class google.appengine.api.client_deployinfo.Request(**attributes)source
-
Bases: google.appengine.api.validation.Validated
A Request describes a single http request within a deployment attempt.
- ATTRIBUTES = {'start_time_usec': <google.appengine.api.validation.Type object>, 'path': <google.appengine.api.validation.Type object>, 'response_code': <google.appengine.api.validation.Range object>, 'end_time_usec': <google.appengine.api.validation.Type object>, 'request_size_bytes': <google.appengine.api.validation.Type object>}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-16 UTC."],[[["\u003cp\u003eThe \u003ccode\u003egoogle.appengine.api.client_deployinfo\u003c/code\u003e module provides tools for parsing and working with \u003ccode\u003eclient_deploy.yaml\u003c/code\u003e files in memory.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eClientDeployInfoExternal\u003c/code\u003e class describes the format of a \u003ccode\u003eclient_deployinfo.yaml\u003c/code\u003e file, specifying attributes like start/end times, success, sdk version, requests, and runtime.\u003c/p\u003e\n"],["\u003cp\u003eThe module defines specific exception types, \u003ccode\u003eEmptyYaml\u003c/code\u003e and \u003ccode\u003eMultipleClientDeployInfo\u003c/code\u003e, to handle errors related to empty or multiple documents within the YAML.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eLoadSingleClientDeployInfo\u003c/code\u003e function parses a \u003ccode\u003eclient_deploy_info.yaml\u003c/code\u003e file or string and returns a \u003ccode\u003eClientDeployInfoExternal\u003c/code\u003e instance, while also raising errors for empty or multiple documents.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRequest\u003c/code\u003e class represents an individual HTTP request within a deployment attempt, including attributes like start/end times, path, response code, and request size.\u003c/p\u003e\n"]]],[],null,["# google.appengine.api.client_deployinfo module\n=============================================\n\nSummary\n-------\n\nClient deploy info.\n\nLibrary for parsing client_deploy.yaml files and working with these in memory.\n\nContents\n--------\n\n*class* google.appengine.api.client_deployinfo.ClientDeployInfoExternal(\\*\\*attributes)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/client_deployinfo#ClientDeployInfoExternal)\n\n: Bases: [google.appengine.api.validation.Validated](/appengine/docs/legacy/standard/python/refdocs/google.appengine.api.validation#google.appengine.api.validation.Validated)\n\n Describes the format of a client_deployinfo.yaml file. \n\n ATTRIBUTES*= {'start_time_usec': \\\u003cgoogle.appengine.api.validation.Type object\\\u003e, 'end_time_usec': \\\u003cgoogle.appengine.api.validation.Type object\\\u003e, 'success': \\\u003cgoogle.appengine.api.validation.Type object\\\u003e, 'sdk_version': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'requests': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'runtime': '((gs://\\[a-z0-9\\\\\\\\-\\\\\\\\._/\\]+)\\|(\\[a-z\\]\\[a-z0-9\\\\\\\\-\\\\\\\\.\\]{0,29}))'}*\n: \n\n*exception* google.appengine.api.client_deployinfo.EmptyYaml[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/client_deployinfo#EmptyYaml)\n\n: Bases: [google.appengine.api.client_deployinfo.Error](#google.appengine.api.client_deployinfo.Error)\n\nTried to load an empty yaml. \n\n*exception* google.appengine.api.client_deployinfo.Error[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/client_deployinfo#Error)\n\n: Bases: exceptions.Exception\n\nBase ClientDeployInfo Exception type. \n\ngoogle.appengine.api.client_deployinfo.LoadSingleClientDeployInfo(client_deploy_info)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/client_deployinfo#LoadSingleClientDeployInfo)\n\n: Returns a ClientDeployInfoExternal from a deploy_info.yaml file or string.\n\n Parameters\n\n client_deploy_info -- The contents of a client_deploy_info.yaml file or\n string, or an open file object.\n Returns\n\n A ClientDeployInfoExternal instance which represents the contents of the\n parsed yaml.\n Raises\n\n - [EmptyYaml](#google.appengine.api.client_deployinfo.EmptyYaml) -- when there are no documents in yaml.\n\n - [MultipleClientDeployInfo](#google.appengine.api.client_deployinfo.MultipleClientDeployInfo) -- when there are multiple documents in yaml.\n\n - yaml_errors.EventError -- when an error occurs while parsing the yaml.\n\n*exception* google.appengine.api.client_deployinfo.MultipleClientDeployInfo[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/client_deployinfo#MultipleClientDeployInfo)\n\n: Bases: [google.appengine.api.client_deployinfo.Error](#google.appengine.api.client_deployinfo.Error)\n\nTried to load a yaml containing multiple client deploy info definitions. \n\n*class* google.appengine.api.client_deployinfo.Request(\\*\\*attributes)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/client_deployinfo#Request)\n\n: Bases: [google.appengine.api.validation.Validated](/appengine/docs/legacy/standard/python/refdocs/google.appengine.api.validation#google.appengine.api.validation.Validated)\n\n A Request describes a single http request within a deployment attempt. \n\n ATTRIBUTES*= {'start_time_usec': \\\u003cgoogle.appengine.api.validation.Type object\\\u003e, 'path': \\\u003cgoogle.appengine.api.validation.Type object\\\u003e, 'response_code': \\\u003cgoogle.appengine.api.validation.Range object\\\u003e, 'end_time_usec': \\\u003cgoogle.appengine.api.validation.Type object\\\u003e, 'request_size_bytes': \\\u003cgoogle.appengine.api.validation.Type object\\\u003e}*\n :"]]
