neulab/docprompting-conala huggingface dataset:
ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, compresslevel=None)  
Write a file into the archive. The contents is data, which may be either a str or a bytes instance; if it is a str, it is encoded as UTF-8 first. zinfo_or_arcname is either the file name it will be given in the archive, or a ZipInfo instance. If it’s an instance, at least the filename, date, and time must be given. If it’s a name, the date and time is set to the current date and time. The archive must be opened with mode 'w', 'x' or 'a'. If given, compress_type overrides the value given for the compression parameter to the constructor for the new entry, or in the zinfo_or_arcname (if that is a ZipInfo instance). Similarly, compresslevel will override the constructor if given.  Note When passing a ZipInfo instance as the zinfo_or_arcname parameter, the compression method used will be that specified in the compress_type member of the given ZipInfo instance. By default, the ZipInfo constructor sets this member to ZIP_STORED.   Changed in version 3.2: The compress_type argument.   Changed in version 3.6: Calling writestr() on a ZipFile created with mode 'r' or a closed ZipFile will raise a ValueError. Previously, a RuntimeError was raised.
class zipfile.ZipInfo(filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))  
Class used to represent information about a member of an archive. Instances of this class are returned by the getinfo() and infolist() methods of ZipFile objects. Most users of the zipfile module will not need to create these, but only use those created by this module. filename should be the full name of the archive member, and date_time should be a tuple containing six fields which describe the time of the last modification to the file; the fields are described in section ZipInfo Objects.
ZipInfo.date_time  
The time and date of the last modification to the archive member. This is a tuple of six values:   
Index Value   
0 Year (>= 1980)  
1 Month (one-based)  
2 Day of month (one-based)  
3 Hours (zero-based)  
4 Minutes (zero-based)  
5 Seconds (zero-based)    Note The ZIP file format does not support timestamps before 1980.
ZipInfo.extra  
Expansion field data. The PKZIP Application Note contains some comments on the internal structure of the data contained in this bytes object.
classmethod ZipInfo.from_file(filename, arcname=None, *, strict_timestamps=True)  
Construct a ZipInfo instance for a file on the filesystem, in preparation for adding it to a zip file. filename should be the path to a file or directory on the filesystem. If arcname is specified, it is used as the name within the archive. If arcname is not specified, the name will be the same as filename, but with any drive letter and leading path separators removed. The strict_timestamps argument, when set to False, allows to zip files older than 1980-01-01 at the cost of setting the timestamp to 1980-01-01. Similar behavior occurs with files newer than 2107-12-31, the timestamp is also set to the limit.  New in version 3.6.   Changed in version 3.6.2: The filename parameter accepts a path-like object.   New in version 3.8: The strict_timestamps keyword-only argument
ZipInfo.is_dir()  
Return True if this archive member is a directory. This uses the entry’s name: directories should always end with /.  New in version 3.6.
zipfile.ZIP_BZIP2  
The numeric constant for the BZIP2 compression method. This requires the bz2 module.  New in version 3.3.
zipfile.ZIP_DEFLATED  
The numeric constant for the usual ZIP compression method. This requires the zlib module.
zipfile.ZIP_LZMA  
The numeric constant for the LZMA compression method. This requires the lzma module.  New in version 3.3.   Note The ZIP file format specification has included support for bzip2 compression since 2001, and for LZMA compression since 2006. However, some tools (including older Python releases) do not support these compression methods, and may either refuse to process the ZIP file altogether, or fail to extract individual files.
class zipimport.zipimporter(archivepath)  
Create a new zipimporter instance. archivepath must be a path to a ZIP file, or to a specific path within a ZIP file. For example, an archivepath of foo/bar.zip/lib will look for modules in the lib directory inside the ZIP file foo/bar.zip (provided that it exists). ZipImportError is raised if archivepath doesn’t point to a valid ZIP archive.  
find_module(fullname[, path])  
Search for a module specified by fullname. fullname must be the fully qualified (dotted) module name. It returns the zipimporter instance itself if the module was found, or None if it wasn’t. The optional path argument is ignored—it’s there for compatibility with the importer protocol. 
  
get_code(fullname)  
Return the code object for the specified module. Raise ZipImportError if the module couldn’t be found. 
  
get_data(pathname)  
Return the data associated with pathname. Raise OSError if the file wasn’t found.  Changed in version 3.3: IOError used to be raised instead of OSError.  
  
get_filename(fullname)  
Return the value __file__ would be set to if the specified module was imported. Raise ZipImportError if the module couldn’t be found.  New in version 3.1.  
  
get_source(fullname)  
Return the source code for the specified module. Raise ZipImportError if the module couldn’t be found, return None if the archive does contain the module, but has no source for it. 
  
is_package(fullname)  
Return True if the module specified by fullname is a package. Raise ZipImportError if the module couldn’t be found. 
  
load_module(fullname)  
Load the module specified by fullname. fullname must be the fully qualified (dotted) module name. It returns the imported module, or raises ZipImportError if it wasn’t found. 
  
archive  
The file name of the importer’s associated ZIP file, without a possible subpath. 
  
prefix  
The subpath within the ZIP file where modules are searched. This is the empty string for zipimporter objects which point to the root of the ZIP file. 
 The archive and prefix attributes, when combined with a slash, equal the original archivepath argument given to the zipimporter constructor.
archive  
The file name of the importer’s associated ZIP file, without a possible subpath.
find_module(fullname[, path])  
Search for a module specified by fullname. fullname must be the fully qualified (dotted) module name. It returns the zipimporter instance itself if the module was found, or None if it wasn’t. The optional path argument is ignored—it’s there for compatibility with the importer protocol.
get_code(fullname)  
Return the code object for the specified module. Raise ZipImportError if the module couldn’t be found.
get_data(pathname)  
Return the data associated with pathname. Raise OSError if the file wasn’t found.  Changed in version 3.3: IOError used to be raised instead of OSError.
get_filename(fullname)  
Return the value __file__ would be set to if the specified module was imported. Raise ZipImportError if the module couldn’t be found.  New in version 3.1.
get_source(fullname)  
Return the source code for the specified module. Raise ZipImportError if the module couldn’t be found, return None if the archive does contain the module, but has no source for it.
is_package(fullname)  
Return True if the module specified by fullname is a package. Raise ZipImportError if the module couldn’t be found.
load_module(fullname)  
Load the module specified by fullname. fullname must be the fully qualified (dotted) module name. It returns the imported module, or raises ZipImportError if it wasn’t found.
prefix  
The subpath within the ZIP file where modules are searched. This is the empty string for zipimporter objects which point to the root of the ZIP file.
exception zipimport.ZipImportError  
Exception raised by zipimporter objects. It’s a subclass of ImportError, so it can be caught as ImportError, too.
zlib.adler32(data[, value])  
Computes an Adler-32 checksum of data. (An Adler-32 checksum is almost as reliable as a CRC32 but can be computed much more quickly.) The result is an unsigned 32-bit integer. If value is present, it is used as the starting value of the checksum; otherwise, a default value of 1 is used. Passing in value allows computing a running checksum over the concatenation of several inputs. The algorithm is not cryptographically strong, and should not be used for authentication or digital signatures. Since the algorithm is designed for use as a checksum algorithm, it is not suitable for use as a general hash algorithm.  Changed in version 3.0: Always returns an unsigned value. To generate the same numeric value across all Python versions and platforms, use adler32(data) & 0xffffffff.
zlib.compress(data, /, level=-1)  
Compresses the bytes in data, returning a bytes object containing compressed data. level is an integer from 0 to 9 or -1 controlling the level of compression; 1 (Z_BEST_SPEED) is fastest and produces the least compression, 9 (Z_BEST_COMPRESSION) is slowest and produces the most. 0 (Z_NO_COMPRESSION) is no compression. The default value is -1 (Z_DEFAULT_COMPRESSION). Z_DEFAULT_COMPRESSION represents a default compromise between speed and compression (currently equivalent to level 6). Raises the error exception if any error occurs.  Changed in version 3.6: level can now be used as a keyword parameter.
Compress.compress(data)  
Compress data, returning a bytes object containing compressed data for at least part of the data in data. This data should be concatenated to the output produced by any preceding calls to the compress() method. Some input may be kept in internal buffers for later processing.
Compress.copy()  
Returns a copy of the compression object. This can be used to efficiently compress a set of data that share a common initial prefix.
Compress.flush([mode])  
All pending input is processed, and a bytes object containing the remaining compressed output is returned. mode can be selected from the constants Z_NO_FLUSH, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, Z_FULL_FLUSH, Z_BLOCK (zlib 1.2.3.4), or Z_FINISH, defaulting to Z_FINISH. Except Z_FINISH, all constants allow compressing further bytestrings of data, while Z_FINISH finishes the compressed stream and prevents compressing any more data. After calling flush() with mode set to Z_FINISH, the compress() method cannot be called again; the only realistic action is to delete the object.
zlib.compressobj(level=-1, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])  
Returns a compression object, to be used for compressing data streams that won’t fit into memory at once. level is the compression level – an integer from 0 to 9 or -1. A value of 1 (Z_BEST_SPEED) is fastest and produces the least compression, while a value of 9 (Z_BEST_COMPRESSION) is slowest and produces the most. 0 (Z_NO_COMPRESSION) is no compression. The default value is -1 (Z_DEFAULT_COMPRESSION). Z_DEFAULT_COMPRESSION represents a default compromise between speed and compression (currently equivalent to level 6). method is the compression algorithm. Currently, the only supported value is DEFLATED. The wbits argument controls the size of the history buffer (or the “window size”) used when compressing data, and whether a header and trailer is included in the output. It can take several ranges of values, defaulting to 15 (MAX_WBITS):  +9 to +15: The base-two logarithm of the window size, which therefore ranges between 512 and 32768. Larger values produce better compression at the expense of greater memory usage. The resulting output will include a zlib-specific header and trailer. −9 to −15: Uses the absolute value of wbits as the window size logarithm, while producing a raw output stream with no header or trailing checksum. +25 to +31 = 16 + (9 to 15): Uses the low 4 bits of the value as the window size logarithm, while including a basic gzip header and trailing checksum in the output.  The memLevel argument controls the amount of memory used for the internal compression state. Valid values range from 1 to 9. Higher values use more memory, but are faster and produce smaller output. strategy is used to tune the compression algorithm. Possible values are Z_DEFAULT_STRATEGY, Z_FILTERED, Z_HUFFMAN_ONLY, Z_RLE (zlib 1.2.0.1) and Z_FIXED (zlib 1.2.2.2). zdict is a predefined compression dictionary. This is a sequence of bytes (such as a bytes object) containing subsequences that are expected to occur frequently in the data that is to be compressed. Those subsequences that are expected to be most common should come at the end of the dictionary.  Changed in version 3.3: Added the zdict parameter and keyword argument support.
zlib.crc32(data[, value])  
Computes a CRC (Cyclic Redundancy Check) checksum of data. The result is an unsigned 32-bit integer. If value is present, it is used as the starting value of the checksum; otherwise, a default value of 0 is used. Passing in value allows computing a running checksum over the concatenation of several inputs. The algorithm is not cryptographically strong, and should not be used for authentication or digital signatures. Since the algorithm is designed for use as a checksum algorithm, it is not suitable for use as a general hash algorithm.  Changed in version 3.0: Always returns an unsigned value. To generate the same numeric value across all Python versions and platforms, use crc32(data) & 0xffffffff.
zlib.decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)  
Decompresses the bytes in data, returning a bytes object containing the uncompressed data. The wbits parameter depends on the format of data, and is discussed further below. If bufsize is given, it is used as the initial size of the output buffer. Raises the error exception if any error occurs. The wbits parameter controls the size of the history buffer (or “window size”), and what header and trailer format is expected. It is similar to the parameter for compressobj(), but accepts more ranges of values:  +8 to +15: The base-two logarithm of the window size. The input must include a zlib header and trailer. 0: Automatically determine the window size from the zlib header. Only supported since zlib 1.2.3.5. −8 to −15: Uses the absolute value of wbits as the window size logarithm. The input must be a raw stream with no header or trailer. +24 to +31 = 16 + (8 to 15): Uses the low 4 bits of the value as the window size logarithm. The input must include a gzip header and trailer. +40 to +47 = 32 + (8 to 15): Uses the low 4 bits of the value as the window size logarithm, and automatically accepts either the zlib or gzip format.  When decompressing a stream, the window size must not be smaller than the size originally used to compress the stream; using a too-small value may result in an error exception. The default wbits value corresponds to the largest window size and requires a zlib header and trailer to be included. bufsize is the initial size of the buffer used to hold decompressed data. If more space is required, the buffer size will be increased as needed, so you don’t have to get this value exactly right; tuning it will only save a few calls to malloc().  Changed in version 3.6: wbits and bufsize can be used as keyword arguments.
Decompress.copy()  
Returns a copy of the decompression object. This can be used to save the state of the decompressor midway through the data stream in order to speed up random seeks into the stream at a future point.
Decompress.decompress(data, max_length=0)  
Decompress data, returning a bytes object containing the uncompressed data corresponding to at least part of the data in string. This data should be concatenated to the output produced by any preceding calls to the decompress() method. Some of the input data may be preserved in internal buffers for later processing. If the optional parameter max_length is non-zero then the return value will be no longer than max_length. This may mean that not all of the compressed input can be processed; and unconsumed data will be stored in the attribute unconsumed_tail. This bytestring must be passed to a subsequent call to decompress() if decompression is to continue. If max_length is zero then the whole input is decompressed, and unconsumed_tail is empty.  Changed in version 3.6: max_length can be used as a keyword argument.
Decompress.eof  
A boolean indicating whether the end of the compressed data stream has been reached. This makes it possible to distinguish between a properly-formed compressed stream, and an incomplete or truncated one.  New in version 3.3.
Decompress.flush([length])  
All pending input is processed, and a bytes object containing the remaining uncompressed output is returned. After calling flush(), the decompress() method cannot be called again; the only realistic action is to delete the object. The optional parameter length sets the initial size of the output buffer.
Decompress.unconsumed_tail  
A bytes object that contains any data that was not consumed by the last decompress() call because it exceeded the limit for the uncompressed data buffer. This data has not yet been seen by the zlib machinery, so you must feed it (possibly with further data concatenated to it) back to a subsequent decompress() method call in order to get correct output.
Decompress.unused_data  
A bytes object which contains any bytes past the end of the compressed data. That is, this remains b"" until the last byte that contains compression data is available. If the whole bytestring turned out to contain compressed data, this is b"", an empty bytes object.
zlib.decompressobj(wbits=MAX_WBITS[, zdict])  
Returns a decompression object, to be used for decompressing data streams that won’t fit into memory at once. The wbits parameter controls the size of the history buffer (or the “window size”), and what header and trailer format is expected. It has the same meaning as described for decompress(). The zdict parameter specifies a predefined compression dictionary. If provided, this must be the same dictionary as was used by the compressor that produced the data that is to be decompressed.  Note If zdict is a mutable object (such as a bytearray), you must not modify its contents between the call to decompressobj() and the first call to the decompressor’s decompress() method.   Changed in version 3.3: Added the zdict parameter.
zlib.ZLIB_RUNTIME_VERSION  
The version string of the zlib library actually loaded by the interpreter.  New in version 3.3.
zlib.ZLIB_VERSION  
The version string of the zlib library that was used for building the module. This may be different from the zlib library actually used at runtime, which is available as ZLIB_RUNTIME_VERSION.
zoneinfo.available_timezones()  
Get a set containing all the valid keys for IANA time zones available anywhere on the time zone path. This is recalculated on every call to the function. This function only includes canonical zone names and does not include “special” zones such as those under the posix/ and right/ directories, or the posixrules zone.  Caution This function may open a large number of files, as the best way to determine if a file on the time zone path is a valid time zone is to read the “magic string” at the beginning.   Note These values are not designed to be exposed to end-users; for user facing elements, applications should use something like CLDR (the Unicode Common Locale Data Repository) to get more user-friendly strings. See also the cautionary note on ZoneInfo.key.
exception zoneinfo.InvalidTZPathWarning  
Raised when PYTHONTZPATH contains an invalid component that will be filtered out, such as a relative path.
zoneinfo.reset_tzpath(to=None)  
Sets or resets the time zone search path (TZPATH) for the module. When called with no arguments, TZPATH is set to the default value. Calling reset_tzpath will not invalidate the ZoneInfo cache, and so calls to the primary ZoneInfo constructor will only use the new TZPATH in the case of a cache miss. The to parameter must be a sequence of strings or os.PathLike and not a string, all of which must be absolute paths. ValueError will be raised if something other than an absolute path is passed.
zoneinfo.TZPATH  
A read-only sequence representing the time zone search path – when constructing a ZoneInfo from a key, the key is joined to each entry in the TZPATH, and the first file found is used. TZPATH may contain only absolute paths, never relative paths, regardless of how it is configured. The object that zoneinfo.TZPATH points to may change in response to a call to reset_tzpath(), so it is recommended to use zoneinfo.TZPATH rather than importing TZPATH from zoneinfo or assigning a long-lived variable to zoneinfo.TZPATH. For more information on configuring the time zone search path, see Configuring the data sources.
class zoneinfo.ZoneInfo(key)  
A concrete datetime.tzinfo subclass that represents an IANA time zone specified by the string key. Calls to the primary constructor will always return objects that compare identically; put another way, barring cache invalidation via ZoneInfo.clear_cache(), for all values of key, the following assertion will always be true: a = ZoneInfo(key)
b = ZoneInfo(key)
assert a is b
 key must be in the form of a relative, normalized POSIX path, with no up-level references. The constructor will raise ValueError if a non-conforming key is passed. If no file matching key is found, the constructor will raise ZoneInfoNotFoundError.
classmethod ZoneInfo.clear_cache(*, only_keys=None)  
A method for invalidating the cache on the ZoneInfo class. If no arguments are passed, all caches are invalidated and the next call to the primary constructor for each key will return a new instance. If an iterable of key names is passed to the only_keys parameter, only the specified keys will be removed from the cache. Keys passed to only_keys but not found in the cache are ignored.  Warning Invoking this function may change the semantics of datetimes using ZoneInfo in surprising ways; this modifies process-wide global state and thus may have wide-ranging effects. Only use it if you know that you need to.
classmethod ZoneInfo.from_file(fobj, /, key=None)  
Constructs a ZoneInfo object from a file-like object returning bytes (e.g. a file opened in binary mode or an io.BytesIO object). Unlike the primary constructor, this always constructs a new object. The key parameter sets the name of the zone for the purposes of __str__() and __repr__(). Objects created via this constructor cannot be pickled (see pickling).
ZoneInfo.key  
This is a read-only attribute that returns the value of key passed to the constructor, which should be a lookup key in the IANA time zone database (e.g. America/New_York, Europe/Paris or Asia/Tokyo). For zones constructed from file without specifying a key parameter, this will be set to None.  Note Although it is a somewhat common practice to expose these to end users, these values are designed to be primary keys for representing the relevant zones and not necessarily user-facing elements. Projects like CLDR (the Unicode Common Locale Data Repository) can be used to get more user-friendly strings from these keys.
classmethod ZoneInfo.no_cache(key)  
An alternate constructor that bypasses the constructor’s cache. It is identical to the primary constructor, but returns a new object on each call. This is most likely to be useful for testing or demonstration purposes, but it can also be used to create a system with a different cache invalidation strategy. Objects created via this constructor will also bypass the cache of a deserializing process when unpickled.  Caution Using this constructor may change the semantics of your datetimes in surprising ways, only use it if you know that you need to.
exception zoneinfo.ZoneInfoNotFoundError  
Raised when construction of a ZoneInfo object fails because the specified key could not be found on the system. This is a subclass of KeyError.
_thread.allocate_lock()  
Return a new lock object. Methods of locks are described below. The lock is initially unlocked.
exception _thread.error  
Raised on thread-specific errors.  Changed in version 3.3: This is now a synonym of the built-in RuntimeError.
_thread.exit()  
Raise the SystemExit exception. When not caught, this will cause the thread to exit silently.