Metadata-Version: 2.1
Name: pyasynchat
Version: 1.0.4
Summary: Make asynchat available for Python 3.12 onwards
Home-page: https://github.com/simonrob/pyasynchat
Author: Simon Robinson
Author-email: simon@robinson.ac
License: Python Software Foundation License Version 2
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: Python Software Foundation License
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyasyncore >=1.0.2

[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)

# Purpose
This package contains the [asynchat](https://docs.python.org/3.11/library/asynchat.html) module as found in Python versions prior to 3.12.
It is provided so that existing code relying on `import asynchat` is able to continue being used without significant refactoring.

The module's source code is taken directly from the [Python standard library](https://github.com/python/cpython/blob/3.9/Lib/asynchat.py)<sup id="a1">[[1]](#f1)</sup>.
The [specific version of asynchat that is provided](https://github.com/simonrob/pyasynchat/blob/master/asynchat/__init__.py) is the last update before the addition of deprecation/removal warnings at import time, and is identical to [the version bundled with Python 3.9](https://github.com/python/cpython/blob/3.9/Lib/asynchat.py) (which was the last time the module was meaningfully updated).

Please note that new projects should prefer [asyncio](https://docs.python.org/3/library/asyncio.html).


## Installation
This version of `asynchat` is intended for Python 3.12 or later. Install the module using `pip`:
```shell
python -m pip install pyasynchat
```

The module can be installed for earlier Python versions, but it will have no effect, and the standard library version of `asynchat` will be used in its place.

Note that installing `pyasynchat` will not remove deprecation warnings in Python versions 3.10 and 3.11.
Instead, use the `warnings` package:
```python
import warnings
with warnings.catch_warnings():
    warnings.simplefilter('ignore', DeprecationWarning)
    import asynchat
```


## Usage
The module is imported in exactly the same way as the standard library component it replaces:
```python
import asynchat
```

Note that the [PyPI module](https://pypi.org/project/pyasynchat/) is named `pyasynchat` because creating modules with the same name as those provided by the standard library is not permitted.

For guidance about using the `asynchat` module, see the [official documentation](https://docs.python.org/3.11/library/asynchat.html).


## Testing
The [previous standard library tests](https://github.com/python/cpython/blob/3.11/Lib/test/test_asynchat.py) have also been replicated into this module.
Run them using:
```shell
python -m unittest
```


## Maintenance
Due to the fact that this previously built-in module is [no-longer supported](https://peps.python.org/pep-0594/) by the Python core development team, no further maintenance of the [asynchat code](https://github.com/simonrob/pyasynchat/blob/master/asynchat/__init__.py) is intended.
This project is only intended to be updated to make changes or improvements to the module packaging.


## License
[Python Software Foundation License Version 2](LICENSE)


### Footnotes
<sub id="f1">1. Verify this if needed via: `diff <(curl --location https://github.com/python/cpython/raw/3.9/Lib/asynchat.py) <(curl --location https://github.com/simonrob/pyasynchat/raw/master/asynchat/__init__.py)` [⏎](#a1)</sub>