.. bpc-utils documentation master file, created by
   sphinx-quickstart on Thu Feb 13 22:20:47 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Python Backport Compiler Utilities
==================================

Utility library for the Python |bpc|_ backport compiler.

.. |bpc| replace:: ``bpc``
.. _bpc: https://github.com/pybpc/bpc

Currently, the three individual tools (|f2format|_, |poseur|_,
|walrus|_) depend on this repo. The |bpc|_ compiler is a
work in progress.

.. |f2format| replace:: ``f2format``
.. _f2format: https://github.com/pybpc/f2format
.. |poseur| replace:: ``poseur``
.. _poseur: https://github.com/pybpc/poseur
.. |walrus| replace:: ``walrus``
.. _walrus: https://github.com/pybpc/walrus

Module contents
---------------

.. automodule:: bpc_utils
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:
   :exclude-members: _abc_impl, Linesep

.. data:: bpc_utils.Linesep

   Type alias for ``Literal['\n', '\r\n', '\r']``.

Internal utilities
------------------

.. data:: bpc_utils.argparse._boolean_state_lookup

   :type: Final[Dict[str, bool]]

   A mapping from string representation to boolean states.
   The values are used for :func:`~bpc_utils.parse_boolean_state`.

.. data:: bpc_utils.argparse._linesep_lookup

   :type: Final[Dict[str, :data:`~bpc_utils.Linesep`]]

   A mapping from string representation to linesep.
   The values are used for :func:`~bpc_utils.parse_linesep`.

.. data:: bpc_utils.fileprocessing.has_gz_support

   :type: bool

   Whether gzip is supported.

.. autodata:: bpc_utils.fileprocessing.LOOKUP_TABLE

.. autofunction:: bpc_utils.fileprocessing.is_python_filename

.. autofunction:: bpc_utils.fileprocessing.expand_glob_iter

.. autoclass:: bpc_utils.logging.BPCLogHandler
   :members:
   :undoc-members:
   :show-inheritance:

.. data:: bpc_utils.misc.is_windows

   :type: bool

   Whether the current operating system is Windows.

.. autofunction:: bpc_utils.misc.current_time_with_tzinfo

.. autoclass:: bpc_utils.misc.MakeTextIO
   :members:
   :undoc-members:
   :show-inheritance:

   .. attribute:: obj

      :type: Union[str, TextIO]

      The object to manage in the context.

   .. attribute:: sio

      :type: StringIO

      The I/O object to manage in the context only if
      :attr:`self.obj <MakeTextIO.obj>` is :obj:`str`.

   .. attribute:: pos

      :type: int

      The original offset of :attr:`self.obj <MakeTextIO.obj>`,
      if only :attr:`self.obj <MakeTextIO.obj>` is a seekable
      :class:`TextIO <io.TextIOWrapper>`.

.. data:: bpc_utils.multiprocessing.CPU_CNT

   :type: int

   Number of CPUs for multiprocessing support.

.. data:: bpc_utils.multiprocessing.mp

   :type: Optional[ModuleType]
   :value: <module 'multiprocessing'>

   An alias of the Python builtin :mod:`multiprocessing` module if available.

.. data:: bpc_utils.multiprocessing.parallel_available

   :type: bool

   Whether parallel execution is available.

.. autofunction:: bpc_utils.multiprocessing._mp_map_wrapper

.. autofunction:: bpc_utils.multiprocessing._mp_init_lock

.. data:: bpc_utils.multiprocessing.task_lock

   :type: ContextManager[None]

   A lock for possibly concurrent tasks.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`