boto3 API Reference
Full documentation for boto3 (1.43.61)
boto3.DEFAULT_SESSION
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
boto3.NullHandler
Python Library Documentation: class NullHandler in module logging class NullHandler(Handler) | NullHandler(level=0) | | This handler does nothing. It's intended to be used to avoid the | "No handlers could be found for logger XXX" one-off warning. This is | important for library code, which may contain code to log events. If a user | of the library does not configure logging, the one-off warning might be | produced; to avoid this, the library developer simply needs to instantiate | a NullHandler and add it to the top-level logger of the library module or | package. | | Method resolution order: | NullHandler | Handler | Filterer | builtins.object | | Methods defined here: | | createLock(self) | Acquire a thread lock for serializing access to the underlying I/O. | | emit(self, record) | Stub. | | handle(self, record) | Stub. | | ---------------------------------------------------------------------- | Methods inherited from Handler: | | __init__(self, level=0) | Initializes the instance - basically setting the formatter to None | and the filter list to empty. | | __repr__(self) | Return repr(self). | | acquire(self) | Acquire the I/O thread lock. | | close(self) | Tidy up any resources used by the handler. | | This version removes the handler from an internal map of handlers, | _handlers, which is used for handler lookup by name. Subclasses | should ensure that this gets called from overridden close() | methods. | | flush(self) | Ensure all logging output has been flushed. | | This version does nothing and is intended to be implemented by | subclasses. | | format(self, record) | Format the specified record. | | If a formatter is set, use it. Otherwise, use the default formatter | for the module. | | get_name(self) | | handleError(self, record) | Handle errors which occur during an emit() call. | | This method should be called from handlers when an exception is | encountered during an emit() call. If raiseExceptions is false, | exceptions get silently ignored. This is what is mostly wanted | for a logging system - most users will not care about errors in | the logging system, they are more interested in application errors. | You could, however, replace this with a custom handler if you wish. | The record which was being processed is passed in to this method. | | release(self) | Release the I/O thread lock. | | setFormatter(self, fmt) | Set the formatter for this handler. | | setLevel(self, level) | Set the logging level of this handler. level must be an int or a str. | | set_name(self, name) | | ---------------------------------------------------------------------- | Data descriptors inherited from Handler: | | name | | ---------------------------------------------------------------------- | Methods inherited from Filterer: | | addFilter(self, filter) | Add the specified filter to this handler. | | filter(self, record) | Determine if a record is loggable by consulting all the filters. | | The default is to allow the record to be logged; any filter can veto | this by returning a false value. | If a filter attached to a handler returns a log record instance, | then that instance is used in place of the original log record in | any further processing of the event by that handler. | If a filter returns any other true value, the original log record | is used in any further processing of the event by that handler. | | If none of the filters return false values, this method returns | a log record. | If any of the filters return a false value, this method returns | a false value. | | .. versionchanged:: 3.2 | | Allow filters to be just callables. | | .. versionchanged:: 3.12 | Allow filters to return a LogRecord instead of | modifying it in place. | | removeFilter(self, filter) | Remove the specified filter from this handler. | | ---------------------------------------------------------------------- | Data descriptors inherited from Filterer: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
boto3.Session
Python Library Documentation: class Session in module boto3.session class Session(builtins.object) | Session(aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, region_name=None, botocore_session=None, profile_name=None, aws_account_id=None) | | A session stores configuration state and allows you to create service | clients and resources. | | :type aws_access_key_id: string | :param aws_access_key_id: AWS access key ID | :type aws_secret_access_key: string | :param aws_secret_access_key: AWS secret access key | :type aws_session_token: string | :param aws_session_token: AWS temporary session token | :type region_name: string | :param region_name: Default region when creating new connections | :type botocore_session: botocore.session.Session | :param botocore_session: Use this Botocore session instead of creating | a new default one. | :type profile_name: string | :param profile_name: The name of a profile to use. If not given, then | the default profile is used. | :type aws_account_id: string | :param aws_account_id: AWS account ID | | Methods defined here: | | __init__(self, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, region_name=None, botocore_session=None, profile_name=None, aws_account_id=None) | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) | Return repr(self). | | client(self, service_name, region_name=None, api_version=None, use_ssl=True, verify=None, endpoint_url=None, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, config=None, aws_account_id=None) | Create a low-level service client by name. | | :type service_name: string | :param service_name: The name of a service, e.g. 's3' or 'ec2'. You | can get a list of available services via | :py:meth:`get_available_services`. | | :type region_name: string | :param region_name: The name of the region associated with the client. | A client is associated with a single region. | | :type api_version: string | :param api_version: The API version to use. By default, botocore will | use the latest API version when creating a client. You only need | to specify this parameter if you want to use a previous API version | of the client. | | :type use_ssl: boolean | :param use_ssl: Whether or not to use SSL. By default, SSL is used. | Note that not all services support non-ssl connections. | | :type verify: boolean/string | :param verify: Whether or not to verify SSL certificates. By default | SSL certificates are verified. You can provide the following | values: | | * False - do not validate SSL certificates. SSL will still be | used (unless use_ssl is False), but SSL certificates | will not be verified. | * path/to/cert/bundle.pem - A filename of the CA cert bundle to | uses. You can specify this argument if you want to use a | different CA cert bundle than the one used by botocore. | | :type endpoint_url: string | :param endpoint_url: The complete URL to use for the constructed | client. Normally, botocore will automatically construct the | appropriate URL to use when communicating with a service. You | can specify a complete URL (including the "http/https" scheme) | to override this behavior. If this value is provided, | then ``use_ssl`` is ignored. | | :type aws_access_key_id: string | :param aws_access_key_id: The access key to use when creating | the client. This is entirely optional, and if not provided, | the credentials configured for the session will automatically | be used. You only need to provide this argument if you want | to override the credentials used for this specific client. | | :type aws_secret_access_key: string | :param aws_secret_access_key: The secret key to use when creating | the client. Same semantics as aws_access_key_id above. | | :type aws_session_token: string | :param aws_session_token: The session token to use when creating | the client. Same semantics as aws_access_key_id above. | | :type config: botocore.client.Config | :param config: Advanced client configuration options. If region_name | is specified in the client config, its value will take precedence | over environment variables and configuration values, but not over | a region_name value passed explicitly to the method. See | `botocore config documentation | <https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_ | for more details. | | :type aws_account_id: string | :param aws_account_id: The account id to use when creating | the client. Same semantics as aws_access_key_id above. | | :return: Service client instance | | get_available_partitions(self) | Lists the available partitions | | :rtype: list | :return: Returns a list of partition names (e.g., ["aws", "aws-cn"]) | | get_available_regions(self, service_name, partition_name='aws', allow_non_regional=False) | Lists the region and endpoint names of a particular partition. | | The list of regions returned by this method are regions that are | explicitly known by the client to exist and is not comprehensive. A | region not returned in this list may still be available for the | provided service. | | :type service_name: string | :param service_name: Name of a service to list endpoint for (e.g., s3). | | :type partition_name: string | :param partition_name: Name of the partition to limit endpoints to. | (e.g., aws for the public AWS endpoints, aws-cn for AWS China | endpoints, aws-us-gov for AWS GovCloud (US) Endpoints, etc.) | | :type allow_non_regional: bool | :param allow_non_regional: Set to True to include endpoints that are | not regional endpoints (e.g., s3-external-1, | fips-us-gov-west-1, etc). | | :return: Returns a list of endpoint names (e.g., ["us-east-1"]). | | get_available_resources(self) | Get a list of available services that can be loaded as resource | clients via :py:meth:`Session.resource`. | | :rtype: list | :return: List of service names | | get_available_services(self) | Get a list of available services that can be loaded as low-level | clients via :py:meth:`Session.client`. | | :rtype: list | :return: List of service names | | get_credentials(self) | Return the :class:`botocore.credentials.Credentials` object | associated with this session. If the credentials have not | yet been loaded, this will attempt to load them. If they | have already been loaded, this will return the cached | credentials. | | get_partition_for_region(self, region_name) | Lists the partition name of a particular region. | | :type region_name: string | :param region_name: Name of the region to list partition for (e.g., | us-east-1). | | :rtype: string | :return: Returns the respective partition name (e.g., aws). | | resource(self, service_name, region_name=None, api_version=None, use_ssl=True, verify=None, endpoint_url=None, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, config=None) | Create a resource service client by name. | | :type service_name: string | :param service_name: The name of a service, e.g. 's3' or 'ec2'. You | can get a list of available services via | :py:meth:`get_available_resources`. | | :type region_name: string | :param region_name: The name of the region associated with the client. | A client is associated with a single region. | | :type api_version: string | :param api_version: The API version to use. By default, botocore will | use the latest API version when creating a client. You only need | to specify this parameter if you want to use a previous API version | of the client. | | :type use_ssl: boolean | :param use_ssl: Whether or not to use SSL. By default, SSL is used. | Note that not all services support non-ssl connections. | | :type verify: boolean/string | :param verify: Whether or not to verify SSL certificates. By default | SSL certificates are verified. You can provide the following | values: | | * False - do not validate SSL certificates. SSL will still be | used (unless use_ssl is False), but SSL certificates | will not be verified. | * path/to/cert/bundle.pem - A filename of the CA cert bundle to | uses. You can specify this argument if you want to use a | different CA cert bundle than the one used by botocore. | | :type endpoint_url: string | :param endpoint_url: The complete URL to use for the constructed | client. Normally, botocore will automatically construct the | appropriate URL to use when communicating with a service. You | can specify a complete URL (including the "http/https" scheme) | to override this behavior. If this value is provided, | then ``use_ssl`` is ignored. | | :type aws_access_key_id: string | :param aws_access_key_id: The access key to use when creating | the client. This is entirely optional, and if not provided, | the credentials configured for the session will automatically | be used. You only need to provide this argument if you want | to override the credentials used for this specific client. | | :type aws_secret_access_key: string | :param aws_secret_access_key: The secret key to use when creating | the client. Same semantics as aws_access_key_id above. | | :type aws_session_token: string | :param aws_session_token: The session token to use when creating | the client. Same semantics as aws_access_key_id above. | | :type config: botocore.client.Config | :param config: Advanced client configuration options. If region_name | is specified in the client config, its value will take precedence | over environment variables and configuration values, but not over | a region_name value passed explicitly to the method. If | user_agent_extra is specified in the client config, it overrides | the default user_agent_extra provided by the resource API. See | `botocore config documentation | <https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_ | for more details. | | :return: Subclass of :py:class:`~boto3.resources.base.ServiceResource` | | ---------------------------------------------------------------------- | Readonly properties defined here: | | available_profiles | The profiles available to the session credentials | | events | The event emitter for a session | | profile_name | The **read-only** profile name. | | region_name | The **read-only** region name. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
boto3.client
Python Library Documentation: function client in module boto3
client(*args, **kwargs)
Create a low-level service client by name using the default session.
See :py:meth:`boto3.session.Session.client`.
boto3.compat
Python Library Documentation: module boto3.compat in boto3
NAME
boto3.compat
DESCRIPTION
# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# https://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
FUNCTIONS
filter_python_deprecation_warnings()
Invoking this filter acknowledges your runtime will soon be deprecated
at which time you will stop receiving all updates to your client.
is_append_mode(fileobj)
rename_file(current_filename, new_filename)
DATA
TRANSFER_CONFIG_SUPPORTS_CRT = True
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\boto3\compat.py
boto3.docs
Python Library Documentation: package boto3.docs in boto3
NAME
boto3.docs
DESCRIPTION
# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# https://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
PACKAGE CONTENTS
action
attr
base
client
collection
docstring
method
resource
service
subresource
utils
waiter
FUNCTIONS
generate_docs(root_dir, session)
Generates the reference documentation for botocore
This will go through every available AWS service and output ReSTructured
text files documenting each service.
:param root_dir: The directory to write the reference files to. Each
service's reference documentation is located at
root_dir/reference/services/service-name.rst
:param session: The boto3 session
DATA
DEPRECATED_SERVICE_NAMES = {'sms-voice'}
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\boto3\docs\__init__.py
boto3.exceptions
Python Library Documentation: module boto3.exceptions in boto3
NAME
boto3.exceptions
DESCRIPTION
# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# https://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
CLASSES
builtins.Exception(builtins.BaseException)
Boto3Error
DynamoDBNeedsConditionError
DynamoDBNeedsKeyConditionError
DynamoDBOperationNotSupportedError
InvalidCrtTransferConfigError
NoVersionFound
ResourceLoadException
ResourceNotExistsError(Boto3Error, botocore.exceptions.DataNotFoundError)
RetriesExceededError
S3TransferFailedError
S3UploadFailedError
UnknownAPIVersionError(Boto3Error, botocore.exceptions.DataNotFoundError)
builtins.Warning(builtins.Exception)
PythonDeprecationWarning
class Boto3Error(builtins.Exception)
| Base class for all Boto3 errors.
|
| Method resolution order:
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class DynamoDBNeedsConditionError(Boto3Error)
| DynamoDBNeedsConditionError(value)
|
| Raised when input is not a condition
|
| Method resolution order:
| DynamoDBNeedsConditionError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, value)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class DynamoDBNeedsKeyConditionError(Boto3Error)
| Method resolution order:
| DynamoDBNeedsKeyConditionError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class DynamoDBOperationNotSupportedError(Boto3Error)
| DynamoDBOperationNotSupportedError(operation, value)
|
| Raised for operations that are not supported for an operand.
|
| Method resolution order:
| DynamoDBOperationNotSupportedError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, operation, value)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
DynanmoDBOperationNotSupportedError = class DynamoDBOperationNotSupportedError(Boto3Error)
| DynanmoDBOperationNotSupportedError(operation, value)
|
| Raised for operations that are not supported for an operand.
|
| Method resolution order:
| DynamoDBOperationNotSupportedError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, operation, value)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class InvalidCrtTransferConfigError(Boto3Error)
| Method resolution order:
| InvalidCrtTransferConfigError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class NoVersionFound(Boto3Error)
| # NOTE: This doesn't appear to be used anywhere.
| # It's probably safe to remove this.
|
| Method resolution order:
| NoVersionFound
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class PythonDeprecationWarning(builtins.Warning)
| Python version being used is scheduled to become unsupported
| in an future release. See warning for specifics.
|
| Method resolution order:
| PythonDeprecationWarning
| builtins.Warning
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Warning:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Warning:
|
| __new__(*args, **kwargs) class method of builtins.Warning
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ResourceLoadException(Boto3Error)
| Method resolution order:
| ResourceLoadException
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ResourceNotExistsError(Boto3Error, botocore.exceptions.DataNotFoundError)
| ResourceNotExistsError(service_name, available_services, has_low_level_client)
|
| Raised when you attempt to create a resource that does not exist.
|
| Method resolution order:
| ResourceNotExistsError
| Boto3Error
| botocore.exceptions.DataNotFoundError
| botocore.exceptions.BotoCoreError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, service_name, available_services, has_low_level_client)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from botocore.exceptions.DataNotFoundError:
|
| fmt = 'Unable to load data for: {data_path}'
|
| ----------------------------------------------------------------------
| Methods inherited from botocore.exceptions.BotoCoreError:
|
| __reduce__(self)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class RetriesExceededError(Boto3Error)
| RetriesExceededError(last_exception, msg='Max Retries Exceeded')
|
| Method resolution order:
| RetriesExceededError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, last_exception, msg='Max Retries Exceeded')
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class S3TransferFailedError(Boto3Error)
| Method resolution order:
| S3TransferFailedError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class S3UploadFailedError(Boto3Error)
| Method resolution order:
| S3UploadFailedError
| Boto3Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UnknownAPIVersionError(Boto3Error, botocore.exceptions.DataNotFoundError)
| UnknownAPIVersionError(service_name, bad_api_version, available_api_versions)
|
| # We're subclassing from botocore.exceptions.DataNotFoundError
| # to keep backwards compatibility with anyone that was catching
| # this low level Botocore error before this exception was
| # introduced in boto3.
| # Same thing for ResourceNotExistsError below.
|
| Method resolution order:
| UnknownAPIVersionError
| Boto3Error
| botocore.exceptions.DataNotFoundError
| botocore.exceptions.BotoCoreError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, service_name, bad_api_version, available_api_versions)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Boto3Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from botocore.exceptions.DataNotFoundError:
|
| fmt = 'Unable to load data for: {data_path}'
|
| ----------------------------------------------------------------------
| Methods inherited from botocore.exceptions.BotoCoreError:
|
| __reduce__(self)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\boto3\exceptions.py
boto3.logging
Python Library Documentation: package logging
NAME
logging
MODULE REFERENCE
https://docs.python.org/3.12/library/logging.html
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
DESCRIPTION
Logging package for Python. Based on PEP 282 and comments thereto in
comp.lang.python.
Copyright (C) 2001-2022 Vinay Sajip. All Rights Reserved.
To use, simply 'import logging' and log away!
PACKAGE CONTENTS
config
handlers
CLASSES
builtins.object
BufferingFormatter
Filter
Formatter
LogRecord
LoggerAdapter
Filterer(builtins.object)
Handler
NullHandler
StreamHandler
FileHandler
Logger
class BufferingFormatter(builtins.object)
| BufferingFormatter(linefmt=None)
|
| A formatter suitable for formatting a number of records.
|
| Methods defined here:
|
| __init__(self, linefmt=None)
| Optionally specify a formatter which will be used to format each
| individual record.
|
| format(self, records)
| Format the specified records and return the result as a string.
|
| formatFooter(self, records)
| Return the footer string for the specified records.
|
| formatHeader(self, records)
| Return the header string for the specified records.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class FileHandler(StreamHandler)
| FileHandler(filename, mode='a', encoding=None, delay=False, errors=None)
|
| A handler class which writes formatted logging records to disk files.
|
| Method resolution order:
| FileHandler
| StreamHandler
| Handler
| Filterer
| builtins.object
|
| Methods defined here:
|
| __init__(self, filename, mode='a', encoding=None, delay=False, errors=None)
| Open the specified file and use it as the stream for logging.
|
| __repr__(self)
| Return repr(self).
|
| close(self)
| Closes the stream.
|
| emit(self, record)
| Emit a record.
|
| If the stream was not opened because 'delay' was specified in the
| constructor, open it before calling the superclass's emit.
|
| If stream is not open, current mode is 'w' and `_closed=True`, record
| will not be emitted (see Issue #42378).
|
| ----------------------------------------------------------------------
| Methods inherited from StreamHandler:
|
| flush(self)
| Flushes the stream.
|
| setStream(self, stream)
| Sets the StreamHandler's stream to the specified value,
| if it is different.
|
| Returns the old stream, if the stream was changed, or None
| if it wasn't.
|
| ----------------------------------------------------------------------
| Class methods inherited from StreamHandler:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from StreamHandler:
|
| terminator = '\n'
|
| ----------------------------------------------------------------------
| Methods inherited from Handler:
|
| acquire(self)
| Acquire the I/O thread lock.
|
| createLock(self)
| Acquire a thread lock for serializing access to the underlying I/O.
|
| format(self, record)
| Format the specified record.
|
| If a formatter is set, use it. Otherwise, use the default formatter
| for the module.
|
| get_name(self)
|
| handle(self, record)
| Conditionally emit the specified logging record.
|
| Emission depends on filters which may have been added to the handler.
| Wrap the actual emission of the record with acquisition/release of
| the I/O thread lock.
|
| Returns an instance of the log record that was emitted
| if it passed all filters, otherwise a false value is returned.
|
| handleError(self, record)
| Handle errors which occur during an emit() call.
|
| This method should be called from handlers when an exception is
| encountered during an emit() call. If raiseExceptions is false,
| exceptions get silently ignored. This is what is mostly wanted
| for a logging system - most users will not care about errors in
| the logging system, they are more interested in application errors.
| You could, however, replace this with a custom handler if you wish.
| The record which was being processed is passed in to this method.
|
| release(self)
| Release the I/O thread lock.
|
| setFormatter(self, fmt)
| Set the formatter for this handler.
|
| setLevel(self, level)
| Set the logging level of this handler. level must be an int or a str.
|
| set_name(self, name)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Handler:
|
| name
|
| ----------------------------------------------------------------------
| Methods inherited from Filterer:
|
| addFilter(self, filter)
| Add the specified filter to this handler.
|
| filter(self, record)
| Determine if a record is loggable by consulting all the filters.
|
| The default is to allow the record to be logged; any filter can veto
| this by returning a false value.
| If a filter attached to a handler returns a log record instance,
| then that instance is used in place of the original log record in
| any further processing of the event by that handler.
| If a filter returns any other true value, the original log record
| is used in any further processing of the event by that handler.
|
| If none of the filters return false values, this method returns
| a log record.
| If any of the filters return a false value, this method returns
| a false value.
|
| .. versionchanged:: 3.2
|
| Allow filters to be just callables.
|
| .. versionchanged:: 3.12
| Allow filters to return a LogRecord instead of
| modifying it in place.
|
| removeFilter(self, filter)
| Remove the specified filter from this handler.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Filterer:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Filter(builtins.object)
| Filter(name='')
|
| Filter instances are used to perform arbitrary filtering of LogRecords.
|
| Loggers and Handlers can optionally use Filter instances to filter
| records as desired. The base filter class only allows events which are
| below a certain point in the logger hierarchy. For example, a filter
| initialized with "A.B" will allow events logged by loggers "A.B",
| "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If
| initialized with the empty string, all events are passed.
|
| Methods defined here:
|
| __init__(self, name='')
| Initialize a filter.
|
| Initialize with the name of the logger which, together with its
| children, will have its events allowed through the filter. If no
| name is specified, allow every event.
|
| filter(self, record)
| Determine if the specified record is to be logged.
|
| Returns True if the record should be logged, or False otherwise.
| If deemed appropriate, the record may be modified in-place.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Formatter(builtins.object)
| Formatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)
|
| Formatter instances are used to convert a LogRecord to text.
|
| Formatters need to know how a LogRecord is constructed. They are
| responsible for converting a LogRecord to (usually) a string which can
| be interpreted by either a human or an external system. The base Formatter
| allows a formatting string to be specified. If none is supplied, the
| style-dependent default value, "%(message)s", "{message}", or
| "${message}", is used.
|
| The Formatter can be initialized with a format string which makes use of
| knowledge of the LogRecord attributes - e.g. the default value mentioned
| above makes use of the fact that the user's message and arguments are pre-
| formatted into a LogRecord's message attribute. Currently, the useful
| attributes in a LogRecord are described by:
|
| %(name)s Name of the logger (logging channel)
| %(levelno)s Numeric logging level for the message (DEBUG, INFO,
| WARNING, ERROR, CRITICAL)
| %(levelname)s Text logging level for the message ("DEBUG", "INFO",
| "WARNING", "ERROR", "CRITICAL")
| %(pathname)s Full pathname of the source file where the logging
| call was issued (if available)
| %(filename)s Filename portion of pathname
| %(module)s Module (name portion of filename)
| %(lineno)d Source line number where the logging call was issued
| (if available)
| %(funcName)s Function name
| %(created)f Time when the LogRecord was created (time.time()
| return value)
| %(asctime)s Textual time when the LogRecord was created
| %(msecs)d Millisecond portion of the creation time
| %(relativeCreated)d Time in milliseconds when the LogRecord was created,
| relative to the time the logging module was loaded
| (typically at application startup time)
| %(thread)d Thread ID (if available)
| %(threadName)s Thread name (if available)
| %(taskName)s Task name (if available)
| %(process)d Process ID (if available)
| %(message)s The result of record.getMessage(), computed just as
| the record is emitted
|
| Methods defined here:
|
| __init__(self, fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)
| Initialize the formatter with specified format strings.
|
| Initialize the formatter either with the specified format string, or a
| default as described above. Allow for specialized date formatting with
| the optional datefmt argument. If datefmt is omitted, you get an
| ISO8601-like (or RFC 3339-like) format.
|
| Use a style parameter of '%', '{' or '$' to specify that you want to
| use one of %-formatting, :meth:`str.format` (``{}``) formatting or
| :class:`string.Template` formatting in your format string.
|
| .. versionchanged:: 3.2
| Added the ``style`` parameter.
|
| format(self, record)
| Format the specified record as text.
|
| The record's attribute dictionary is used as the operand to a
| string formatting operation which yields the returned string.
| Before formatting the dictionary, a couple of preparatory steps
| are carried out. The message attribute of the record is computed
| using LogRecord.getMessage(). If the formatting string uses the
| time (as determined by a call to usesTime(), formatTime() is
| called to format the event time. If there is exception information,
| it is formatted using formatException() and appended to the message.
|
| formatException(self, ei)
| Format and return the specified exception information as a string.
|
| This default implementation just uses
| traceback.print_exception()
|
| formatMessage(self, record)
|
| formatStack(self, stack_info)
| This method is provided as an extension point for specialized
| formatting of stack information.
|
| The input data is a string as returned from a call to
| :func:`traceback.print_stack`, but with the last trailing newline
| removed.
|
| The base implementation just returns the value passed in.
|
| formatTime(self, record, datefmt=None)
| Return the creation time of the specified LogRecord as formatted text.
|
| This method should be called from format() by a formatter which
| wants to make use of a formatted time. This method can be overridden
| in formatters to provide for any specific requirement, but the
| basic behaviour is as follows: if datefmt (a string) is specified,
| it is used with time.strftime() to format the creation time of the
| record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used.
| The resulting string is returned. This function uses a user-configurable
| function to convert the creation time to a tuple. By default,
| time.localtime() is used; to change this for a particular formatter
| instance, set the 'converter' attribute to a function with the same
| signature as time.localtime() or time.gmtime(). To change it for all
| formatters, for example if you want all logging times to be shown in GMT,
| set the 'converter' attribute in the Formatter class.
|
| usesTime(self)
| Check if the format uses the creation time of the record.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| converter = localtime(...)
| localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,
| tm_sec,tm_wday,tm_yday,tm_isdst)
|
| Convert seconds since the Epoch to a time tuple expressing local time.
| When 'seconds' is not passed in, convert the current time instead.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| default_msec_format = '%s,%03d'
|
| default_time_format = '%Y-%m-%d %H:%M:%S'
class Handler(Filterer)
| Handler(level=0)
|
| Handler instances dispatch logging events to specific destinations.
|
| The base handler class. Acts as a placeholder which defines the Handler
| interface. Handlers can optionally use Formatter instances to format
| records as desired. By default, no formatter is specified; in this case,
| the 'raw' message as determined by record.message is logged.
|
| Method resolution order:
| Handler
| Filterer
| builtins.object
|
| Methods defined here:
|
| __init__(self, level=0)
| Initializes the instance - basically setting the formatter to None
| and the filter list to empty.
|
| __repr__(self)
| Return repr(self).
|
| acquire(self)
| Acquire the I/O thread lock.
|
| close(self)
| Tidy up any resources used by the handler.
|
| This version removes the handler from an internal map of handlers,
| _handlers, which is used for handler lookup by name. Subclasses
| should ensure that this gets called from overridden close()
| methods.
|
| createLock(self)
| Acquire a thread lock for serializing access to the underlying I/O.
|
| emit(self, record)
| Do whatever it takes to actually log the specified logging record.
|
| This version is intended to be implemented by subclasses and so
| raises a NotImplementedError.
|
| flush(self)
| Ensure all logging output has been flushed.
|
| This version does nothing and is intended to be implemented by
| subclasses.
|
| format(self, record)
| Format the specified record.
|
| If a formatter is set, use it. Otherwise, use the default formatter
| for the module.
|
| get_name(self)
|
| handle(self, record)
| Conditionally emit the specified logging record.
|
| Emission depends on filters which may have been added to the handler.
| Wrap the actual emission of the record with acquisition/release of
| the I/O thread lock.
|
| Returns an instance of the log record that was emitted
| if it passed all filters, otherwise a false value is returned.
|
| handleError(self, record)
| Handle errors which occur during an emit() call.
|
| This method should be called from handlers when an exception is
| encountered during an emit() call. If raiseExceptions is false,
| exceptions get silently ignored. This is what is mostly wanted
| for a logging system - most users will not care about errors in
| the logging system, they are more interested in application errors.
| You could, however, replace this with a custom handler if you wish.
| The record which was being processed is passed in to this method.
|
| release(self)
| Release the I/O thread lock.
|
| setFormatter(self, fmt)
| Set the formatter for this handler.
|
| setLevel(self, level)
| Set the logging level of this handler. level must be an int or a str.
|
| set_name(self, name)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| name
|
| ----------------------------------------------------------------------
| Methods inherited from Filterer:
|
| addFilter(self, filter)
| Add the specified filter to this handler.
|
| filter(self, record)
| Determine if a record is loggable by consulting all the filters.
|
| The default is to allow the record to be logged; any filter can veto
| this by returning a false value.
| If a filter attached to a handler returns a log record instance,
| then that instance is used in place of the original log record in
| any further processing of the event by that handler.
| If a filter returns any other true value, the original log record
| is used in any further processing of the event by that handler.
|
| If none of the filters return false values, this method returns
| a log record.
| If any of the filters return a false value, this method returns
| a false value.
|
| .. versionchanged:: 3.2
|
| Allow filters to be just callables.
|
| .. versionchanged:: 3.12
| Allow filters to return a LogRecord instead of
| modifying it in place.
|
| removeFilter(self, filter)
| Remove the specified filter from this handler.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Filterer:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class LogRecord(builtins.object)
| LogRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None, **kwargs)
|
| A LogRecord instance represents an event being logged.
|
| LogRecord instances are created every time something is logged. They
| contain all the information pertinent to the event being logged. The
| main information passed in is in msg and args, which are combined
| using str(msg) % args to create the message field of the record. The
| record also includes information such as when the record was created,
| the source line where the logging call was made, and any exception
| information to be logged.
|
| Methods defined here:
|
| __init__(self, name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None, **kwargs)
| Initialize a logging record with interesting information.
|
| __repr__(self)
| Return repr(self).
|
| getMessage(self)
| Return the message for this LogRecord.
|
| Return the message for this LogRecord after merging any user-supplied
| arguments with the message.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Logger(Filterer)
| Logger(name, level=0)
|
| Instances of the Logger class represent a single logging channel. A
| "logging channel" indicates an area of an application. Exactly how an
| "area" is defined is up to the application developer. Since an
| application can have any number of areas, logging channels are identified
| by a unique string. Application areas can be nested (e.g. an area
| of "input processing" might include sub-areas "read CSV files", "read
| XLS files" and "read Gnumeric files"). To cater for this natural nesting,
| channel names are organized into a namespace hierarchy where levels are
| separated by periods, much like the Java or Python package namespace. So
| in the instance given above, channel names might be "input" for the upper
| level, and "input.csv", "input.xls" and "input.gnu" for the sub-levels.
| There is no arbitrary limit to the depth of nesting.
|
| Method resolution order:
| Logger
| Filterer
| builtins.object
|
| Methods defined here:
|
| __init__(self, name, level=0)
| Initialize the logger with a name and an optional level.
|
| __reduce__(self)
| Helper for pickle.
|
| __repr__(self)
| Return repr(self).
|
| addHandler(self, hdlr)
| Add the specified handler to this logger.
|
| callHandlers(self, record)
| Pass a record to all relevant handlers.
|
| Loop through all handlers for this logger and its parents in the
| logger hierarchy. If no handler was found, output a one-off error
| message to sys.stderr. Stop searching up the hierarchy whenever a
| logger with the "propagate" attribute set to zero is found - that
| will be the last logger whose handlers are called.
|
| critical(self, msg, *args, **kwargs)
| Log 'msg % args' with severity 'CRITICAL'.
|
| To pass exception information, use the keyword argument exc_info with
| a true value, e.g.
|
| logger.critical("Houston, we have a %s", "major disaster", exc_info=True)
|
| debug(self, msg, *args, **kwargs)
| Log 'msg % args' with severity 'DEBUG'.
|
| To pass exception information, use the keyword argument exc_info with
| a true value, e.g.
|
| logger.debug("Houston, we have a %s", "thorny problem", exc_info=True)
|
| error(self, msg, *args, **kwargs)
| Log 'msg % args' with severity 'ERROR'.
|
| To pass exception information, use the keyword argument exc_info with
| a true value, e.g.
|
| logger.error("Houston, we have a %s", "major problem", exc_info=True)
|
| exception(self, msg, *args, exc_info=True, **kwargs)
| Convenience method for logging an ERROR with exception information.
|
| fatal(self, msg, *args, **kwargs)
| Don't use this method, use critical() instead.
|
| findCaller(self, stack_info=False, stacklevel=1)
| Find the stack frame of the caller so that we can note the source
| file name, line number and function name.
|
| getChild(self, suffix)
| Get a logger which is a descendant to this one.
|
| This is a convenience method, such that
|
| logging.getLogger('abc').getChild('def.ghi')
|
| is the same as
|
| logging.getLogger('abc.def.ghi')
|
| It's useful, for example, when the parent logger is named using
| __name__ rather than a literal string.
|
| getChildren(self)
|
| getEffectiveLevel(self)
| Get the effective level for this logger.
|
| Loop through this logger and its parents in the logger hierarchy,
| looking for a non-zero logging level. Return the first one found.
|
| handle(self, record)
| Call the handlers for the specified record.
|
| This method is used for unpickled records received from a socket, as
| well as those created locally. Logger-level filtering is applied.
|
| hasHandlers(self)
| See if this logger has any handlers configured.
|
| Loop through all handlers for this logger and its parents in the
| logger hierarchy. Return True if a handler was found, else False.
| Stop searching up the hierarchy whenever a logger with the "propagate"
| attribute set to zero is found - that will be the last logger which
| is checked for the existence of handlers.
|
| info(self, msg, *args, **kwargs)
| Log 'msg % args' with severity 'INFO'.
|
| To pass exception information, use the keyword argument exc_info with
| a true value, e.g.
|
| logger.info("Houston, we have a %s", "notable problem", exc_info=True)
|
| isEnabledFor(self, level)
| Is this logger enabled for level 'level'?
|
| log(self, level, msg, *args, **kwargs)
| Log 'msg % args' with the integer severity 'level'.
|
| To pass exception information, use the keyword argument exc_info with
| a true value, e.g.
|
| logger.log(level, "We have a %s", "mysterious problem", exc_info=True)
|
| makeRecord(self, name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)
| A factory method which can be overridden in subclasses to create
| specialized LogRecords.
|
| removeHandler(self, hdlr)
| Remove the specified handler from this logger.
|
| setLevel(self, level)
| Set the logging level of this logger. level must be an int or a str.
|
| warn(self, msg, *args, **kwargs)
|
| warning(self, msg, *args, **kwargs)
| Log 'msg % args' with severity 'WARNING'.
|
| To pass exception information, use the keyword argument exc_info with
| a true value, e.g.
|
| logger.warning("Houston, we have a %s", "bit of a problem", exc_info=True)
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| manager = <logging.Manager object>
|
| root = <RootLogger root (WARNING)>
|
| ----------------------------------------------------------------------
| Methods inherited from Filterer:
|
| addFilter(self, filter)
| Add the specified filter to this handler.
|
| filter(self, record)
| Determine if a record is loggable by consulting all the filters.
|
| The default is to allow the record to be logged; any filter can veto
| this by returning a false value.
| If a filter attached to a handler returns a log record instance,
| then that instance is used in place of the original log record in
| any further processing of the event by that handler.
| If a filter returns any other true value, the original log record
| is used in any further processing of the event by that handler.
|
| If none of the filters return false values, this method returns
| a log record.
| If any of the filters return a false value, this method returns
| a false value.
|
| .. versionchanged:: 3.2
|
| Allow filters to be just callables.
|
| .. versionchanged:: 3.12
| Allow filters to return a LogRecord instead of
| modifying it in place.
|
| removeFilter(self, filter)
| Remove the specified filter from this handler.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Filterer:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class LoggerAdapter(builtins.object)
| LoggerAdapter(logger, extra=None)
|
| An adapter for loggers which makes it easier to specify contextual
| information in logging output.
|
| Methods defined here:
|
| __init__(self, logger, extra=None)
| Initialize the adapter with a logger and a dict-like object which
| provides contextual information. This constructor signature allows
| easy stacking of LoggerAdapters, if so desired.
|
| You can effectively pass keyword arguments as shown in the
| following example:
|
| adapter = LoggerAdapter(someLogger, dict(p1=v1, p2="v2"))
|
| __repr__(self)
| Return repr(self).
|
| critical(self, msg, *args, **kwargs)
| Delegate a critical call to the underlying logger.
|
| debug(self, msg, *args, **kwargs)
| Delegate a debug call to the underlying logger.
|
| error(self, msg, *args, **kwargs)
| Delegate an error call to the underlying logger.
|
| exception(self, msg, *args, exc_info=True, **kwargs)
| Delegate an exception call to the underlying logger.
|
| getEffectiveLevel(self)
| Get the effective level for the underlying logger.
|
| hasHandlers(self)
| See if the underlying logger has any handlers.
|
| info(self, msg, *args, **kwargs)
| Delegate an info call to the underlying logger.
|
| isEnabledFor(self, level)
| Is this logger enabled for level 'level'?
|
| log(self, level, msg, *args, **kwargs)
| Delegate a log call to the underlying logger, after adding
| contextual information from this adapter instance.
|
| process(self, msg, kwargs)
| Process the logging message and keyword arguments passed in to
| a logging call to insert contextual information. You can either
| manipulate the message itself, the keyword args or both. Return
| the message and kwargs modified (or not) to suit your needs.
|
| Normally, you'll only need to override this one method in a
| LoggerAdapter subclass for your specific needs.
|
| setLevel(self, level)
| Set the specified level on the underlying logger.
|
| warn(self, msg, *args, **kwargs)
|
| warning(self, msg, *args, **kwargs)
| Delegate a warning call to the underlying logger.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| name
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| manager
class NullHandler(Handler)
| NullHandler(level=0)
|
| This handler does nothing. It's intended to be used to avoid the
| "No handlers could be found for logger XXX" one-off warning. This is
| important for library code, which may contain code to log events. If a user
| of the library does not configure logging, the one-off warning might be
| produced; to avoid this, the library developer simply needs to instantiate
| a NullHandler and add it to the top-level logger of the library module or
| package.
|
| Method resolution order:
| NullHandler
| Handler
| Filterer
| builtins.object
|
| Methods defined here:
|
| createLock(self)
| Acquire a thread lock for serializing access to the underlying I/O.
|
| emit(self, record)
| Stub.
|
| handle(self, record)
| Stub.
|
| ----------------------------------------------------------------------
| Methods inherited from Handler:
|
| __init__(self, level=0)
| Initializes the instance - basically setting the formatter to None
| and the filter list to empty.
|
| __repr__(self)
| Return repr(self).
|
| acquire(self)
| Acquire the I/O thread lock.
|
| close(self)
| Tidy up any resources used by the handler.
|
| This version removes the handler from an internal map of handlers,
| _handlers, which is used for handler lookup by name. Subclasses
| should ensure that this gets called from overridden close()
| methods.
|
| flush(self)
| Ensure all logging output has been flushed.
|
| This version does nothing and is intended to be implemented by
| subclasses.
|
| format(self, record)
| Format the specified record.
|
| If a formatter is set, use it. Otherwise, use the default formatter
| for the module.
|
| get_name(self)
|
| handleError(self, record)
| Handle errors which occur during an emit() call.
|
| This method should be called from handlers when an exception is
| encountered during an emit() call. If raiseExceptions is false,
| exceptions get silently ignored. This is what is mostly wanted
| for a logging system - most users will not care about errors in
| the logging system, they are more interested in application errors.
| You could, however, replace this with a custom handler if you wish.
| The record which was being processed is passed in to this method.
|
| release(self)
| Release the I/O thread lock.
|
| setFormatter(self, fmt)
| Set the formatter for this handler.
|
| setLevel(self, level)
| Set the logging level of this handler. level must be an int or a str.
|
| set_name(self, name)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Handler:
|
| name
|
| ----------------------------------------------------------------------
| Methods inherited from Filterer:
|
| addFilter(self, filter)
| Add the specified filter to this handler.
|
| filter(self, record)
| Determine if a record is loggable by consulting all the filters.
|
| The default is to allow the record to be logged; any filter can veto
| this by returning a false value.
| If a filter attached to a handler returns a log record instance,
| then that instance is used in place of the original log record in
| any further processing of the event by that handler.
| If a filter returns any other true value, the original log record
| is used in any further processing of the event by that handler.
|
| If none of the filters return false values, this method returns
| a log record.
| If any of the filters return a false value, this method returns
| a false value.
|
| .. versionchanged:: 3.2
|
| Allow filters to be just callables.
|
| .. versionchanged:: 3.12
| Allow filters to return a LogRecord instead of
| modifying it in place.
|
| removeFilter(self, filter)
| Remove the specified filter from this handler.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Filterer:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class StreamHandler(Handler)
| StreamHandler(stream=None)
|
| A handler class which writes logging records, appropriately formatted,
| to a stream. Note that this class does not close the stream, as
| sys.stdout or sys.stderr may be used.
|
| Method resolution order:
| StreamHandler
| Handler
| Filterer
| builtins.object
|
| Methods defined here:
|
| __init__(self, stream=None)
| Initialize the handler.
|
| If stream is not specified, sys.stderr is used.
|
| __repr__(self)
| Return repr(self).
|
| emit(self, record)
| Emit a record.
|
| If a formatter is specified, it is used to format the record.
| The record is then written to the stream with a trailing newline. If
| exception information is present, it is formatted using
| traceback.print_exception and appended to the stream. If the stream
| has an 'encoding' attribute, it is used to determine how to do the
| output to the stream.
|
| flush(self)
| Flushes the stream.
|
| setStream(self, stream)
| Sets the StreamHandler's stream to the specified value,
| if it is different.
|
| Returns the old stream, if the stream was changed, or None
| if it wasn't.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| terminator = '\n'
|
| ----------------------------------------------------------------------
| Methods inherited from Handler:
|
| acquire(self)
| Acquire the I/O thread lock.
|
| close(self)
| Tidy up any resources used by the handler.
|
| This version removes the handler from an internal map of handlers,
| _handlers, which is used for handler lookup by name. Subclasses
| should ensure that this gets called from overridden close()
| methods.
|
| createLock(self)
| Acquire a thread lock for serializing access to the underlying I/O.
|
| format(self, record)
| Format the specified record.
|
| If a formatter is set, use it. Otherwise, use the default formatter
| for the module.
|
| get_name(self)
|
| handle(self, record)
| Conditionally emit the specified logging record.
|
| Emission depends on filters which may have been added to the handler.
| Wrap the actual emission of the record with acquisition/release of
| the I/O thread lock.
|
| Returns an instance of the log record that was emitted
| if it passed all filters, otherwise a false value is returned.
|
| handleError(self, record)
| Handle errors which occur during an emit() call.
|
| This method should be called from handlers when an exception is
| encountered during an emit() call. If raiseExceptions is false,
| exceptions get silently ignored. This is what is mostly wanted
| for a logging system - most users will not care about errors in
| the logging system, they are more interested in application errors.
| You could, however, replace this with a custom handler if you wish.
| The record which was being processed is passed in to this method.
|
| release(self)
| Release the I/O thread lock.
|
| setFormatter(self, fmt)
| Set the formatter for this handler.
|
| setLevel(self, level)
| Set the logging level of this handler. level must be an int or a str.
|
| set_name(self, name)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Handler:
|
| name
|
| ----------------------------------------------------------------------
| Methods inherited from Filterer:
|
| addFilter(self, filter)
| Add the specified filter to this handler.
|
| filter(self, record)
| Determine if a record is loggable by consulting all the filters.
|
| The default is to allow the record to be logged; any filter can veto
| this by returning a false value.
| If a filter attached to a handler returns a log record instance,
| then that instance is used in place of the original log record in
| any further processing of the event by that handler.
| If a filter returns any other true value, the original log record
| is used in any further processing of the event by that handler.
|
| If none of the filters return false values, this method returns
| a log record.
| If any of the filters return a false value, this method returns
| a false value.
|
| .. versionchanged:: 3.2
|
| Allow filters to be just callables.
|
| .. versionchanged:: 3.12
| Allow filters to return a LogRecord instead of
| modifying it in place.
|
| removeFilter(self, filter)
| Remove the specified filter from this handler.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Filterer:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FUNCTIONS
addLevelName(level, levelName)
Associate 'levelName' with 'level'.
This is used when converting levels to text during message formatting.
basicConfig(**kwargs)
Do basic configuration for the logging system.
This function does nothing if the root logger already has handlers
configured, unless the keyword argument *force* is set to ``True``.
It is a convenience method intended for use by simple scripts
to do one-shot configuration of the logging package.
The default behaviour is to create a StreamHandler which writes to
sys.stderr, set a formatter using the BASIC_FORMAT format string, and
add the handler to the root logger.
A number of optional keyword arguments may be specified, which can alter
the default behaviour.
filename Specifies that a FileHandler be created, using the specified
filename, rather than a StreamHandler.
filemode Specifies the mode to open the file, if filename is specified
(if filemode is unspecified, it defaults to 'a').
format Use the specified format string for the handler.
datefmt Use the specified date/time format.
style If a format string is specified, use this to specify the
type of format string (possible values '%', '{', '$', for
%-formatting, :meth:`str.format` and :class:`string.Template`
- defaults to '%').
level Set the root logger level to the specified level.
stream Use the specified stream to initialize the StreamHandler. Note
that this argument is incompatible with 'filename' - if both
are present, 'stream' is ignored.
handlers If specified, this should be an iterable of already created
handlers, which will be added to the root logger. Any handler
in the list which does not have a formatter assigned will be
assigned the formatter created in this function.
force If this keyword is specified as true, any existing handlers
attached to the root logger are removed and closed, before
carrying out the configuration as specified by the other
arguments.
encoding If specified together with a filename, this encoding is passed to
the created FileHandler, causing it to be used when the file is
opened.
errors If specified together with a filename, this value is passed to the
created FileHandler, causing it to be used when the file is
opened in text mode. If not specified, the default value is
`backslashreplace`.
Note that you could specify a stream created using open(filename, mode)
rather than passing the filename and mode in. However, it should be
remembered that StreamHandler does not close its stream (since it may be
using sys.stdout or sys.stderr), whereas FileHandler closes its stream
when the handler is closed.
.. versionchanged:: 3.2
Added the ``style`` parameter.
.. versionchanged:: 3.3
Added the ``handlers`` parameter. A ``ValueError`` is now thrown for
incompatible arguments (e.g. ``handlers`` specified together with
``filename``/``filemode``, or ``filename``/``filemode`` specified
together with ``stream``, or ``handlers`` specified together with
``stream``.
.. versionchanged:: 3.8
Added the ``force`` parameter.
.. versionchanged:: 3.9
Added the ``encoding`` and ``errors`` parameters.
captureWarnings(capture)
If capture is true, redirect all warnings to the logging package.
If capture is False, ensure that warnings are not redirected to logging
but to their original destinations.
critical(msg, *args, **kwargs)
Log a message with severity 'CRITICAL' on the root logger. If the logger
has no handlers, call basicConfig() to add a console handler with a
pre-defined format.
debug(msg, *args, **kwargs)
Log a message with severity 'DEBUG' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
disable(level=50)
Disable all logging calls of severity 'level' and below.
error(msg, *args, **kwargs)
Log a message with severity 'ERROR' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
exception(msg, *args, exc_info=True, **kwargs)
Log a message with severity 'ERROR' on the root logger, with exception
information. If the logger has no handlers, basicConfig() is called to add
a console handler with a pre-defined format.
fatal(msg, *args, **kwargs)
Don't use this function, use critical() instead.
getHandlerByName(name)
Get a handler with the specified *name*, or None if there isn't one with
that name.
getHandlerNames()
Return all known handler names as an immutable set.
getLevelName(level)
Return the textual or numeric representation of logging level 'level'.
If the level is one of the predefined levels (CRITICAL, ERROR, WARNING,
INFO, DEBUG) then you get the corresponding string. If you have
associated levels with names using addLevelName then the name you have
associated with 'level' is returned.
If a numeric value corresponding to one of the defined levels is passed
in, the corresponding string representation is returned.
If a string representation of the level is passed in, the corresponding
numeric value is returned.
If no matching numeric or string value is passed in, the string
'Level %s' % level is returned.
getLevelNamesMapping()
getLogRecordFactory()
Return the factory to be used when instantiating a log record.
getLogger(name=None)
Return a logger with the specified name, creating it if necessary.
If no name is specified, return the root logger.
getLoggerClass()
Return the class to be used when instantiating a logger.
info(msg, *args, **kwargs)
Log a message with severity 'INFO' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
log(level, msg, *args, **kwargs)
Log 'msg % args' with the integer severity 'level' on the root logger. If
the logger has no handlers, call basicConfig() to add a console handler
with a pre-defined format.
makeLogRecord(dict)
Make a LogRecord whose attributes are defined by the specified dictionary,
This function is useful for converting a logging event received over
a socket connection (which is sent as a dictionary) into a LogRecord
instance.
setLogRecordFactory(factory)
Set the factory to be used when instantiating a log record.
:param factory: A callable which will be called to instantiate
a log record.
setLoggerClass(klass)
Set the class to be used when instantiating a logger. The class should
define __init__() such that only a name argument is required, and the
__init__() should call Logger.__init__()
shutdown(handlerList=[<weakref at 0x0000020732366890; to '_StderrHandler' at 0x0000020732362990>, <weakref at 0x00000207323BD9E0; to 'NullHandler' at 0x0000020732397770>, <weakref at 0x0000020733D6DE40; to 'NullHandler' at 0x0000020733D86C60>, <weakref at 0x00000207323F5FD0; to 'NullHandler' at 0x00000207323CC3E0>, <weakref at 0x0000020731F01BC0; to 'NullHandler' at 0x00000207323425D0>])
Perform any cleanup actions in the logging system (e.g. flushing
buffers).
Should be called at application exit.
warn(msg, *args, **kwargs)
warning(msg, *args, **kwargs)
Log a message with severity 'WARNING' on the root logger. If the logger has
no handlers, call basicConfig() to add a console handler with a pre-defined
format.
DATA
BASIC_FORMAT = '%(levelname)s:%(name)s:%(message)s'
CRITICAL = 50
DEBUG = 10
ERROR = 40
FATAL = 50
INFO = 20
NOTSET = 0
WARN = 30
WARNING = 30
__all__ = ['BASIC_FORMAT', 'BufferingFormatter', 'CRITICAL', 'DEBUG', ...
__status__ = 'production'
lastResort = <_StderrHandler <stderr> (WARNING)>
raiseExceptions = True
VERSION
0.5.1.2
DATE
07 February 2010
AUTHOR
Vinay Sajip <vinay_sajip@red-dove.com>
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\logging\__init__.py
boto3.resource
Python Library Documentation: function resource in module boto3
resource(*args, **kwargs)
Create a resource service client by name using the default session.
See :py:meth:`boto3.session.Session.resource`.
boto3.resources
Python Library Documentation: package boto3.resources in boto3
NAME
boto3.resources
PACKAGE CONTENTS
action
base
collection
factory
model
params
response
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\boto3\resources\__init__.py
boto3.session
Python Library Documentation: module boto3.session in boto3
NAME
boto3.session
DESCRIPTION
# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# https://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
CLASSES
builtins.object
Session
class Session(builtins.object)
| Session(aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, region_name=None, botocore_session=None, profile_name=None, aws_account_id=None)
|
| A session stores configuration state and allows you to create service
| clients and resources.
|
| :type aws_access_key_id: string
| :param aws_access_key_id: AWS access key ID
| :type aws_secret_access_key: string
| :param aws_secret_access_key: AWS secret access key
| :type aws_session_token: string
| :param aws_session_token: AWS temporary session token
| :type region_name: string
| :param region_name: Default region when creating new connections
| :type botocore_session: botocore.session.Session
| :param botocore_session: Use this Botocore session instead of creating
| a new default one.
| :type profile_name: string
| :param profile_name: The name of a profile to use. If not given, then
| the default profile is used.
| :type aws_account_id: string
| :param aws_account_id: AWS account ID
|
| Methods defined here:
|
| __init__(self, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, region_name=None, botocore_session=None, profile_name=None, aws_account_id=None)
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self)
| Return repr(self).
|
| client(self, service_name, region_name=None, api_version=None, use_ssl=True, verify=None, endpoint_url=None, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, config=None, aws_account_id=None)
| Create a low-level service client by name.
|
| :type service_name: string
| :param service_name: The name of a service, e.g. 's3' or 'ec2'. You
| can get a list of available services via
| :py:meth:`get_available_services`.
|
| :type region_name: string
| :param region_name: The name of the region associated with the client.
| A client is associated with a single region.
|
| :type api_version: string
| :param api_version: The API version to use. By default, botocore will
| use the latest API version when creating a client. You only need
| to specify this parameter if you want to use a previous API version
| of the client.
|
| :type use_ssl: boolean
| :param use_ssl: Whether or not to use SSL. By default, SSL is used.
| Note that not all services support non-ssl connections.
|
| :type verify: boolean/string
| :param verify: Whether or not to verify SSL certificates. By default
| SSL certificates are verified. You can provide the following
| values:
|
| * False - do not validate SSL certificates. SSL will still be
| used (unless use_ssl is False), but SSL certificates
| will not be verified.
| * path/to/cert/bundle.pem - A filename of the CA cert bundle to
| uses. You can specify this argument if you want to use a
| different CA cert bundle than the one used by botocore.
|
| :type endpoint_url: string
| :param endpoint_url: The complete URL to use for the constructed
| client. Normally, botocore will automatically construct the
| appropriate URL to use when communicating with a service. You
| can specify a complete URL (including the "http/https" scheme)
| to override this behavior. If this value is provided,
| then ``use_ssl`` is ignored.
|
| :type aws_access_key_id: string
| :param aws_access_key_id: The access key to use when creating
| the client. This is entirely optional, and if not provided,
| the credentials configured for the session will automatically
| be used. You only need to provide this argument if you want
| to override the credentials used for this specific client.
|
| :type aws_secret_access_key: string
| :param aws_secret_access_key: The secret key to use when creating
| the client. Same semantics as aws_access_key_id above.
|
| :type aws_session_token: string
| :param aws_session_token: The session token to use when creating
| the client. Same semantics as aws_access_key_id above.
|
| :type config: botocore.client.Config
| :param config: Advanced client configuration options. If region_name
| is specified in the client config, its value will take precedence
| over environment variables and configuration values, but not over
| a region_name value passed explicitly to the method. See
| `botocore config documentation
| <https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_
| for more details.
|
| :type aws_account_id: string
| :param aws_account_id: The account id to use when creating
| the client. Same semantics as aws_access_key_id above.
|
| :return: Service client instance
|
| get_available_partitions(self)
| Lists the available partitions
|
| :rtype: list
| :return: Returns a list of partition names (e.g., ["aws", "aws-cn"])
|
| get_available_regions(self, service_name, partition_name='aws', allow_non_regional=False)
| Lists the region and endpoint names of a particular partition.
|
| The list of regions returned by this method are regions that are
| explicitly known by the client to exist and is not comprehensive. A
| region not returned in this list may still be available for the
| provided service.
|
| :type service_name: string
| :param service_name: Name of a service to list endpoint for (e.g., s3).
|
| :type partition_name: string
| :param partition_name: Name of the partition to limit endpoints to.
| (e.g., aws for the public AWS endpoints, aws-cn for AWS China
| endpoints, aws-us-gov for AWS GovCloud (US) Endpoints, etc.)
|
| :type allow_non_regional: bool
| :param allow_non_regional: Set to True to include endpoints that are
| not regional endpoints (e.g., s3-external-1,
| fips-us-gov-west-1, etc).
|
| :return: Returns a list of endpoint names (e.g., ["us-east-1"]).
|
| get_available_resources(self)
| Get a list of available services that can be loaded as resource
| clients via :py:meth:`Session.resource`.
|
| :rtype: list
| :return: List of service names
|
| get_available_services(self)
| Get a list of available services that can be loaded as low-level
| clients via :py:meth:`Session.client`.
|
| :rtype: list
| :return: List of service names
|
| get_credentials(self)
| Return the :class:`botocore.credentials.Credentials` object
| associated with this session. If the credentials have not
| yet been loaded, this will attempt to load them. If they
| have already been loaded, this will return the cached
| credentials.
|
| get_partition_for_region(self, region_name)
| Lists the partition name of a particular region.
|
| :type region_name: string
| :param region_name: Name of the region to list partition for (e.g.,
| us-east-1).
|
| :rtype: string
| :return: Returns the respective partition name (e.g., aws).
|
| resource(self, service_name, region_name=None, api_version=None, use_ssl=True, verify=None, endpoint_url=None, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, config=None)
| Create a resource service client by name.
|
| :type service_name: string
| :param service_name: The name of a service, e.g. 's3' or 'ec2'. You
| can get a list of available services via
| :py:meth:`get_available_resources`.
|
| :type region_name: string
| :param region_name: The name of the region associated with the client.
| A client is associated with a single region.
|
| :type api_version: string
| :param api_version: The API version to use. By default, botocore will
| use the latest API version when creating a client. You only need
| to specify this parameter if you want to use a previous API version
| of the client.
|
| :type use_ssl: boolean
| :param use_ssl: Whether or not to use SSL. By default, SSL is used.
| Note that not all services support non-ssl connections.
|
| :type verify: boolean/string
| :param verify: Whether or not to verify SSL certificates. By default
| SSL certificates are verified. You can provide the following
| values:
|
| * False - do not validate SSL certificates. SSL will still be
| used (unless use_ssl is False), but SSL certificates
| will not be verified.
| * path/to/cert/bundle.pem - A filename of the CA cert bundle to
| uses. You can specify this argument if you want to use a
| different CA cert bundle than the one used by botocore.
|
| :type endpoint_url: string
| :param endpoint_url: The complete URL to use for the constructed
| client. Normally, botocore will automatically construct the
| appropriate URL to use when communicating with a service. You
| can specify a complete URL (including the "http/https" scheme)
| to override this behavior. If this value is provided,
| then ``use_ssl`` is ignored.
|
| :type aws_access_key_id: string
| :param aws_access_key_id: The access key to use when creating
| the client. This is entirely optional, and if not provided,
| the credentials configured for the session will automatically
| be used. You only need to provide this argument if you want
| to override the credentials used for this specific client.
|
| :type aws_secret_access_key: string
| :param aws_secret_access_key: The secret key to use when creating
| the client. Same semantics as aws_access_key_id above.
|
| :type aws_session_token: string
| :param aws_session_token: The session token to use when creating
| the client. Same semantics as aws_access_key_id above.
|
| :type config: botocore.client.Config
| :param config: Advanced client configuration options. If region_name
| is specified in the client config, its value will take precedence
| over environment variables and configuration values, but not over
| a region_name value passed explicitly to the method. If
| user_agent_extra is specified in the client config, it overrides
| the default user_agent_extra provided by the resource API. See
| `botocore config documentation
| <https://docs.aws.amazon.com/botocore/latest/reference/config.html>`_
| for more details.
|
| :return: Subclass of :py:class:`~boto3.resources.base.ServiceResource`
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| available_profiles
| The profiles available to the session credentials
|
| events
| The event emitter for a session
|
| profile_name
| The **read-only** profile name.
|
| region_name
| The **read-only** region name.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\boto3\session.py
boto3.set_stream_logger
Python Library Documentation: function set_stream_logger in module boto3
set_stream_logger(name='boto3', level=10, format_string=None)
Add a stream handler for the given name and level to the logging module.
By default, this logs all boto3 messages to ``stdout``.
>>> import boto3
>>> boto3.set_stream_logger('boto3.resources', logging.INFO)
For debugging purposes a good choice is to set the stream logger to ``''``
which is equivalent to saying "log everything".
.. WARNING::
Be aware that when logging anything from ``'botocore'`` the full wire
trace will appear in your logs. If your payloads contain sensitive data
this should not be used in production.
:type name: string
:param name: Log name
:type level: int
:param level: Logging level, e.g. ``logging.INFO``
:type format_string: str
:param format_string: Log message format
boto3.setup_default_session
Python Library Documentation: function setup_default_session in module boto3
setup_default_session(**kwargs)
Set up a default session, passing through any parameters to the session
constructor. There is no need to call this unless you wish to pass custom
parameters, because a default session will be created for you.
boto3.utils
Python Library Documentation: module boto3.utils in boto3
NAME
boto3.utils
DESCRIPTION
# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# https://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
CLASSES
ServiceContext(builtins.tuple)
ServiceContext
builtins.object
LazyLoadedWaiterModel
class LazyLoadedWaiterModel(builtins.object)
| LazyLoadedWaiterModel(bc_session, service_name, api_version)
|
| A lazily loaded waiter model
|
| This does not load the service waiter model until an attempt is made
| to retrieve the waiter model for a specific waiter. This is helpful
| in docstring generation where we do not need to actually need to grab
| the waiter-2.json until it is accessed through a ``get_waiter`` call
| when the docstring is generated/accessed.
|
| Methods defined here:
|
| __init__(self, bc_session, service_name, api_version)
| Initialize self. See help(type(self)) for accurate signature.
|
| get_waiter(self, waiter_name)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ServiceContext(ServiceContext)
| ServiceContext(service_name, service_model, service_waiter_model, resource_json_definitions)
|
| Provides important service-wide, read-only information about a service
|
| :type service_name: str
| :param service_name: The name of the service
|
| :type service_model: :py:class:`botocore.model.ServiceModel`
| :param service_model: The model of the service.
|
| :type service_waiter_model: :py:class:`botocore.waiter.WaiterModel` or
| a waiter model-like object such as
| :py:class:`boto3.utils.LazyLoadedWaiterModel`
| :param service_waiter_model: The waiter model of the service.
|
| :type resource_json_definitions: dict
| :param resource_json_definitions: The loaded json models of all resource
| shapes for a service. It is equivalient of loading a
| ``resource-1.json`` and retrieving the value at the key "resources".
|
| Method resolution order:
| ServiceContext
| ServiceContext
| builtins.tuple
| builtins.object
|
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| ----------------------------------------------------------------------
| Methods inherited from ServiceContext:
|
| __getnewargs__(self) from collections.ServiceContext
| Return self as a plain tuple. Used by copy and pickle.
|
| __repr__(self) from collections.ServiceContext
| Return a nicely formatted representation string
|
| _asdict(self) from collections.ServiceContext
| Return a new dict which maps field names to their values.
|
| _replace(self, /, **kwds) from collections.ServiceContext
| Return a new ServiceContext object replacing specified fields with new values
|
| ----------------------------------------------------------------------
| Class methods inherited from ServiceContext:
|
| _make(iterable) from collections.ServiceContext
| Make a new ServiceContext object from a sequence or iterable
|
| ----------------------------------------------------------------------
| Static methods inherited from ServiceContext:
|
| __new__(_cls, service_name, service_model, service_waiter_model, resource_json_definitions) from namedtuple_ServiceContext.ServiceContext
| Create new instance of ServiceContext(service_name, service_model, service_waiter_model, resource_json_definitions)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ServiceContext:
|
| service_name
| Alias for field number 0
|
| service_model
| Alias for field number 1
|
| service_waiter_model
| Alias for field number 2
|
| resource_json_definitions
| Alias for field number 3
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from ServiceContext:
|
| __match_args__ = ('service_name', 'service_model', 'service_waiter_mod...
|
| _field_defaults = {}
|
| _fields = ('service_name', 'service_model', 'service_waiter_model', 'r...
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.tuple:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.tuple:
|
| __class_getitem__(...)
| See PEP 585
FUNCTIONS
inject_attribute(class_attributes, name, value)
lazy_call(full_name, **kwargs)
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\boto3\utils.py