PyPI - commonpy - Versions diffs - 1.13.0__tar.gz → 1.13.2__tar.gz - Mend

commonpy 1.13.0tar.gz → 1.13.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (29) hide show

{commonpy-1.13.0 → commonpy-1.13.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: commonpy
-Version: 1.13.0
+Version: 1.13.2
 Summary: Assortment of Python helper functions and utility classes
 Home-page: https://github.com/caltechlibrary/commonpy
 Author: Michael Hucka
@@ -18,10 +18,26 @@ Classifier: Operating System :: POSIX
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: Unix
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.6
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: PyYAML>=5.3.1
+Requires-Dist: boltons==21.0.0
+Requires-Dist: dateparser==1.1.8
+Requires-Dist: deprecation==2.1.0
+Requires-Dist: h2>=4.4.1
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: humanize>=3.9.0
+Requires-Dist: python_dateutil==2.8.2
+Requires-Dist: pywin32>=301; sys_platform == "win32"
+Requires-Dist: regex<=2022.3.2
+Requires-Dist: setuptools>=67.5.1
+Requires-Dist: sidetrack>=2.0.0
+Requires-Dist: tldextract==3.0.2
+Requires-Dist: validator-collection==1.5.0
+Dynamic: license-file
+Dynamic: requires-dist
 CommonPy<img width="12%" align="right" src="https://github.com/caltechlibrary/commonpy/raw/main/.graphics/commonpy-icon.png">
 ===============================================
@@ -30,7 +46,7 @@ This is a collection of common utility functions and classes that we at the Calt
 [![Latest release](https://img.shields.io/github/v/release/caltechlibrary/commonpy.svg?style=flat-square&color=b44e88&label=Latest%20release)](https://github.com/caltechlibrary/commonpy/releases)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square)](https://choosealicense.com/licenses/bsd-3-clause)
-[![Python](https://img.shields.io/badge/Python-3.6+-brightgreen.svg?style=flat-square)](http://shields.io)
+[![Python](https://img.shields.io/badge/Python-3.10+-brightgreen.svg?style=flat-square)](http://shields.io)
 [![PyPI](https://img.shields.io/pypi/v/commonpy.svg?style=flat-square&color=orange&label=PyPI)](https://pypi.org/project/commonpy/)
 Table of contents
@@ -171,28 +187,37 @@ The `network_utils` module provides several functions that are useful when perfo
 | `hostname(url)`                  | Returns the hostname portion of a URL                               |
 | `net(...)`                       | See below                                                           |
 | `netlock(url)`                   | Returns the hostname, port number (if any), and login info (if any) |
+| `network(...)`                   | See below                                                           |
 | `network_available()`            | Returns `True` if external hosts are reacheable over the network    |
 | `on_localhost(url)`              | Returns `True` if the address of `url` points to the local host     |
 | `scheme(url)`                    | Returns the protocol portion of the url; e.g., "https"              |
-#### _`net`_
+#### _`network` and `net`_
-The `net` function in the `network_utils` module implements a fairly high-level network operation interface that internally handles timeouts, rate limits, polling, HTTP/2, and more. The function signature is:
+The `network` and `net` functions in the `network_utils` module implements a fairly high-level network operation interface that internally handles timeouts, rate limits, polling, HTTP/2, and more. The function signatures are identical to this:
 ```python
-net(method, url, client = None, handle_rate = True, polling = False, recursing = 0, **kwargs)
+network(method, url, client = None, handle_rate = True, polling = False, **kwargs)
 ```
-The `method` parameter should have a value such as `'get'`, `'post'`, `'head'`, or similar.  The function returns a tuple of (response, exception), where the first element is the response from the get or post HTTP call, and the second element is an exception object if an exception occurred.  If no exception occurred, the second element will be `None`.  This allows the caller to inspect the response even in cases where exceptions are raised.
+The difference between the two functions is their behavior with respect to exceptions. The function `network` returns only a `response` object, and raises an exception if any error occurs. The `net` function returns two values: `response, error` and does not raise exceptions except in the case of bad arguments; instead, any exceptions are returned as the `error` value in the list of return values. This allows the caller to inspect the `response` object even in cases where exceptions are raised.
-If keyword `client` is not `None`, it's assumed to be a [Python HTTPX Client](https://www.python-httpx.org) object to use for the network call.  Settings such as timeouts should be done by the caller creating appropriately-configured [Client](https://www.python-httpx.org/api/#client) objects.
+The `response` object returned by both `net` and `network` is the response from the get or post HTTP call. This object comes from the Python [HTTPX](https://www.python-httpx.org) module used by
-If keyword `handle_rate` is `True`, this function will automatically pause and retry if it receives an HTTP code 429 ("too many requests") from the server.  If `False`, it will return the exception `CommonPy.RateLimitExceeded` instead.
+The `method` parameter value must be a string chosen from the list of known HTTP methods: `"get"`, `"post"`, `"head"`, `"options"`, `"put"`, `"delete"`, or `"patch"`.
+The `url` parameter value must be the URL to which the HTTP method will be applied.
+If keyword `client` is not `None`, it's assumed to be a [HTTPX Client](https://www.python-httpx.org/api/#client)  object to use for the network call.  Settings such as timeouts should be done by the caller creating appropriately-configured [Client](https://www.python-httpx.org/api/#client) objects.
+If keyword `handle_rate` is `True`, both functions will automatically pause and retry if it receives an HTTP code 429 ("too many requests") from the server.  If `False`, it will return the exception `CommonPy.exceptions.RateLimitExceeded` instead.
 If keyword `polling` is `True`, certain statuses like 404 are ignored and the response is returned; otherwise, they are considered errors.  The behavior when `True` is useful in situations where a URL does not exist until something is ready at the server, and the caller is repeatedly checking the URL.  It is up to the caller to implement the polling schedule and call this function (with `polling = True`) as needed.
-This method always passes the argument `allow_redirects = True` to the underlying Python HTTPX library network calls.
+Additional keyword arguments understood by [HTTPX](https://www.python-httpx.org) can be passed to both `network` and `net`.
+Both methods always pass the argument `allow_redirects = True` to the underlying Python HTTPX library network calls.
 #### _`download` and `download_file`_

{commonpy-1.13.0 → commonpy-1.13.2}/README.md RENAMED Viewed

@@ -5,7 +5,7 @@ This is a collection of common utility functions and classes that we at the Calt
 [![Latest release](https://img.shields.io/github/v/release/caltechlibrary/commonpy.svg?style=flat-square&color=b44e88&label=Latest%20release)](https://github.com/caltechlibrary/commonpy/releases)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square)](https://choosealicense.com/licenses/bsd-3-clause)
-[![Python](https://img.shields.io/badge/Python-3.6+-brightgreen.svg?style=flat-square)](http://shields.io)
+[![Python](https://img.shields.io/badge/Python-3.10+-brightgreen.svg?style=flat-square)](http://shields.io)
 [![PyPI](https://img.shields.io/pypi/v/commonpy.svg?style=flat-square&color=orange&label=PyPI)](https://pypi.org/project/commonpy/)
 Table of contents
@@ -146,28 +146,37 @@ The `network_utils` module provides several functions that are useful when perfo
 | `hostname(url)`                  | Returns the hostname portion of a URL                               |
 | `net(...)`                       | See below                                                           |
 | `netlock(url)`                   | Returns the hostname, port number (if any), and login info (if any) |
+| `network(...)`                   | See below                                                           |
 | `network_available()`            | Returns `True` if external hosts are reacheable over the network    |
 | `on_localhost(url)`              | Returns `True` if the address of `url` points to the local host     |
 | `scheme(url)`                    | Returns the protocol portion of the url; e.g., "https"              |
-#### _`net`_
+#### _`network` and `net`_
-The `net` function in the `network_utils` module implements a fairly high-level network operation interface that internally handles timeouts, rate limits, polling, HTTP/2, and more. The function signature is:
+The `network` and `net` functions in the `network_utils` module implements a fairly high-level network operation interface that internally handles timeouts, rate limits, polling, HTTP/2, and more. The function signatures are identical to this:
 ```python
-net(method, url, client = None, handle_rate = True, polling = False, recursing = 0, **kwargs)
+network(method, url, client = None, handle_rate = True, polling = False, **kwargs)
 ```
-The `method` parameter should have a value such as `'get'`, `'post'`, `'head'`, or similar.  The function returns a tuple of (response, exception), where the first element is the response from the get or post HTTP call, and the second element is an exception object if an exception occurred.  If no exception occurred, the second element will be `None`.  This allows the caller to inspect the response even in cases where exceptions are raised.
+The difference between the two functions is their behavior with respect to exceptions. The function `network` returns only a `response` object, and raises an exception if any error occurs. The `net` function returns two values: `response, error` and does not raise exceptions except in the case of bad arguments; instead, any exceptions are returned as the `error` value in the list of return values. This allows the caller to inspect the `response` object even in cases where exceptions are raised.
-If keyword `client` is not `None`, it's assumed to be a [Python HTTPX Client](https://www.python-httpx.org) object to use for the network call.  Settings such as timeouts should be done by the caller creating appropriately-configured [Client](https://www.python-httpx.org/api/#client) objects.
+The `response` object returned by both `net` and `network` is the response from the get or post HTTP call. This object comes from the Python [HTTPX](https://www.python-httpx.org) module used by
-If keyword `handle_rate` is `True`, this function will automatically pause and retry if it receives an HTTP code 429 ("too many requests") from the server.  If `False`, it will return the exception `CommonPy.RateLimitExceeded` instead.
+The `method` parameter value must be a string chosen from the list of known HTTP methods: `"get"`, `"post"`, `"head"`, `"options"`, `"put"`, `"delete"`, or `"patch"`.
+The `url` parameter value must be the URL to which the HTTP method will be applied.
+If keyword `client` is not `None`, it's assumed to be a [HTTPX Client](https://www.python-httpx.org/api/#client)  object to use for the network call.  Settings such as timeouts should be done by the caller creating appropriately-configured [Client](https://www.python-httpx.org/api/#client) objects.
+If keyword `handle_rate` is `True`, both functions will automatically pause and retry if it receives an HTTP code 429 ("too many requests") from the server.  If `False`, it will return the exception `CommonPy.exceptions.RateLimitExceeded` instead.
 If keyword `polling` is `True`, certain statuses like 404 are ignored and the response is returned; otherwise, they are considered errors.  The behavior when `True` is useful in situations where a URL does not exist until something is ready at the server, and the caller is repeatedly checking the URL.  It is up to the caller to implement the polling schedule and call this function (with `polling = True`) as needed.
-This method always passes the argument `allow_redirects = True` to the underlying Python HTTPX library network calls.
+Additional keyword arguments understood by [HTTPX](https://www.python-httpx.org) can be passed to both `network` and `net`.
+Both methods always pass the argument `allow_redirects = True` to the underlying Python HTTPX library network calls.
 #### _`download` and `download_file`_

{commonpy-1.13.0 → commonpy-1.13.2}/commonpy/__init__.py RENAMED Viewed

@@ -21,7 +21,7 @@ file "LICENSE" for more information.
 #  |    by the Makefile. Manual changes to these values will be lost.      |
 #  ╰────────────────────── Notice ── Notice ── Notice ─────────────────────╯
-__version__     = '1.13.0'
+__version__     = '1.13.2'
 __description__ = 'Assortment of Python helper functions and utility classes'
 __url__         = 'https://github.com/caltechlibrary/commonpy'
 __author__      = 'Michael Hucka'

{commonpy-1.13.0 → commonpy-1.13.2}/commonpy.egg-info/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: commonpy
-Version: 1.13.0
+Version: 1.13.2
 Summary: Assortment of Python helper functions and utility classes
 Home-page: https://github.com/caltechlibrary/commonpy
 Author: Michael Hucka
@@ -18,10 +18,26 @@ Classifier: Operating System :: POSIX
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: Unix
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.6
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: PyYAML>=5.3.1
+Requires-Dist: boltons==21.0.0
+Requires-Dist: dateparser==1.1.8
+Requires-Dist: deprecation==2.1.0
+Requires-Dist: h2>=4.4.1
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: humanize>=3.9.0
+Requires-Dist: python_dateutil==2.8.2
+Requires-Dist: pywin32>=301; sys_platform == "win32"
+Requires-Dist: regex<=2022.3.2
+Requires-Dist: setuptools>=67.5.1
+Requires-Dist: sidetrack>=2.0.0
+Requires-Dist: tldextract==3.0.2
+Requires-Dist: validator-collection==1.5.0
+Dynamic: license-file
+Dynamic: requires-dist
 CommonPy<img width="12%" align="right" src="https://github.com/caltechlibrary/commonpy/raw/main/.graphics/commonpy-icon.png">
 ===============================================
@@ -30,7 +46,7 @@ This is a collection of common utility functions and classes that we at the Calt
 [![Latest release](https://img.shields.io/github/v/release/caltechlibrary/commonpy.svg?style=flat-square&color=b44e88&label=Latest%20release)](https://github.com/caltechlibrary/commonpy/releases)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square)](https://choosealicense.com/licenses/bsd-3-clause)
-[![Python](https://img.shields.io/badge/Python-3.6+-brightgreen.svg?style=flat-square)](http://shields.io)
+[![Python](https://img.shields.io/badge/Python-3.10+-brightgreen.svg?style=flat-square)](http://shields.io)
 [![PyPI](https://img.shields.io/pypi/v/commonpy.svg?style=flat-square&color=orange&label=PyPI)](https://pypi.org/project/commonpy/)
 Table of contents
@@ -171,28 +187,37 @@ The `network_utils` module provides several functions that are useful when perfo
 | `hostname(url)`                  | Returns the hostname portion of a URL                               |
 | `net(...)`                       | See below                                                           |
 | `netlock(url)`                   | Returns the hostname, port number (if any), and login info (if any) |
+| `network(...)`                   | See below                                                           |
 | `network_available()`            | Returns `True` if external hosts are reacheable over the network    |
 | `on_localhost(url)`              | Returns `True` if the address of `url` points to the local host     |
 | `scheme(url)`                    | Returns the protocol portion of the url; e.g., "https"              |
-#### _`net`_
+#### _`network` and `net`_
-The `net` function in the `network_utils` module implements a fairly high-level network operation interface that internally handles timeouts, rate limits, polling, HTTP/2, and more. The function signature is:
+The `network` and `net` functions in the `network_utils` module implements a fairly high-level network operation interface that internally handles timeouts, rate limits, polling, HTTP/2, and more. The function signatures are identical to this:
 ```python
-net(method, url, client = None, handle_rate = True, polling = False, recursing = 0, **kwargs)
+network(method, url, client = None, handle_rate = True, polling = False, **kwargs)
 ```
-The `method` parameter should have a value such as `'get'`, `'post'`, `'head'`, or similar.  The function returns a tuple of (response, exception), where the first element is the response from the get or post HTTP call, and the second element is an exception object if an exception occurred.  If no exception occurred, the second element will be `None`.  This allows the caller to inspect the response even in cases where exceptions are raised.
+The difference between the two functions is their behavior with respect to exceptions. The function `network` returns only a `response` object, and raises an exception if any error occurs. The `net` function returns two values: `response, error` and does not raise exceptions except in the case of bad arguments; instead, any exceptions are returned as the `error` value in the list of return values. This allows the caller to inspect the `response` object even in cases where exceptions are raised.
-If keyword `client` is not `None`, it's assumed to be a [Python HTTPX Client](https://www.python-httpx.org) object to use for the network call.  Settings such as timeouts should be done by the caller creating appropriately-configured [Client](https://www.python-httpx.org/api/#client) objects.
+The `response` object returned by both `net` and `network` is the response from the get or post HTTP call. This object comes from the Python [HTTPX](https://www.python-httpx.org) module used by
-If keyword `handle_rate` is `True`, this function will automatically pause and retry if it receives an HTTP code 429 ("too many requests") from the server.  If `False`, it will return the exception `CommonPy.RateLimitExceeded` instead.
+The `method` parameter value must be a string chosen from the list of known HTTP methods: `"get"`, `"post"`, `"head"`, `"options"`, `"put"`, `"delete"`, or `"patch"`.
+The `url` parameter value must be the URL to which the HTTP method will be applied.
+If keyword `client` is not `None`, it's assumed to be a [HTTPX Client](https://www.python-httpx.org/api/#client)  object to use for the network call.  Settings such as timeouts should be done by the caller creating appropriately-configured [Client](https://www.python-httpx.org/api/#client) objects.
+If keyword `handle_rate` is `True`, both functions will automatically pause and retry if it receives an HTTP code 429 ("too many requests") from the server.  If `False`, it will return the exception `CommonPy.exceptions.RateLimitExceeded` instead.
 If keyword `polling` is `True`, certain statuses like 404 are ignored and the response is returned; otherwise, they are considered errors.  The behavior when `True` is useful in situations where a URL does not exist until something is ready at the server, and the caller is repeatedly checking the URL.  It is up to the caller to implement the polling schedule and call this function (with `polling = True`) as needed.
-This method always passes the argument `allow_redirects = True` to the underlying Python HTTPX library network calls.
+Additional keyword arguments understood by [HTTPX](https://www.python-httpx.org) can be passed to both `network` and `net`.
+Both methods always pass the argument `allow_redirects = True` to the underlying Python HTTPX library network calls.
 #### _`download` and `download_file`_

{commonpy-1.13.0 → commonpy-1.13.2}/commonpy.egg-info/requires.txt RENAMED Viewed

@@ -2,8 +2,8 @@ PyYAML>=5.3.1
 boltons==21.0.0
 dateparser==1.1.8
 deprecation==2.1.0
-h2==4.0.0
-httpx==0.23.1
+h2>=4.4.1
+httpx>=0.28.1
 humanize>=3.9.0
 python_dateutil==2.8.2
 regex<=2022.3.2

{commonpy-1.13.0 → commonpy-1.13.2}/setup.cfg RENAMED Viewed

@@ -1,6 +1,6 @@
 [metadata]
 name = commonpy
-version = 1.13.0
+version = 1.13.2
 description = Assortment of Python helper functions and utility classes
 author = Michael Hucka
 author_email = mhucka@caltech.edu
@@ -21,14 +21,14 @@ classifiers =
 	Operating System :: POSIX :: Linux
 	Operating System :: Unix
 	Programming Language :: Python
-	Programming Language :: Python :: 3.6
+	Programming Language :: Python :: 3.10
 long_description = file:README.md
 long_description_content_type = text/markdown
 [options]
 packages = find:
 zip_safe = False
-python_requires = >= 3.6
+python_requires = >= 3.10
 [egg_info]
 tag_build =