dateutil.zoneinfo

package documentation

(source)

Undocumented

Module rebuild No module docstring; 3/3 functions documented

From __init__.py:

Class	`tzfile`	Undocumented
Class	`ZoneInfoFile`	No class docstring; 0/2 instance variable, 1/2 method documented
Function	`get_zonefile_instance`	This is a convenience function which provides a :class:`ZoneInfoFile` instance using the data provided by the ``dateutil`` package. By default, it caches a single instance of the ZoneInfoFile object and returns that.
Function	`gettz`	This retrieves a time zone from the local zoneinfo tarball that is packaged with dateutil.
Function	`gettz_db_metadata`	Get the zonefile metadata
Function	`getzoneinfofile_stream`	Undocumented
Constant	`METADATA_FN`	Undocumented
Constant	`ZONEFILENAME`	Undocumented
Constant	`_CLASS_ZONE_INSTANCE`	Undocumented

ZONEFILENAME: str = (source)

Undocumented

Value

'dateutil-zoneinfo.tar.gz'

METADATA_FN: str = (source)

Undocumented

Value

'METADATA'

def getzoneinfofile_stream(): (source)

Undocumented

_CLASS_ZONE_INSTANCE: list = (source)

Undocumented

Value

[]

def get_zonefile_instance(new_instance=False): (source)

This is a convenience function which provides a :class:`ZoneInfoFile` instance using the data provided by the ``dateutil`` package. By default, it caches a single instance of the ZoneInfoFile object and returns that. :param new_instance: If ``True``, a new instance of :class:`ZoneInfoFile` is instantiated and used as the cached instance for the next call. Otherwise, new instances are created only as necessary. :return: Returns a :class:`ZoneInfoFile` object. .. versionadded:: 2.6

def gettz(name): (source)

This retrieves a time zone from the local zoneinfo tarball that is packaged with dateutil. :param name: An IANA-style time zone name, as found in the zoneinfo file. :return: Returns a :class:`dateutil.tz.tzfile` time zone object. .. warning:: It is generally inadvisable to use this function, and it is only provided for API compatibility with earlier versions. This is *not* equivalent to ``dateutil.tz.gettz()``, which selects an appropriate time zone based on the inputs, favoring system zoneinfo. This is ONLY for accessing the dateutil-specific zoneinfo (which may be out of date compared to the system zoneinfo). .. deprecated:: 2.6 If you need to use a specific zoneinfofile over the system zoneinfo, instantiate a :class:`dateutil.zoneinfo.ZoneInfoFile` object and call :func:`dateutil.zoneinfo.ZoneInfoFile.get(name)` instead. Use :func:`get_zonefile_instance` to retrieve an instance of the dateutil-provided zoneinfo.

def gettz_db_metadata(): (source)

Get the zonefile metadata See `zonefile_metadata`_ :returns: A dictionary with the database metadata .. deprecated:: 2.6 See deprecation warning in :func:`zoneinfo.gettz`. To get metadata, query the attribute ``zoneinfo.ZoneInfoFile.metadata``.