communal 0.4.5__tar.gz

communal-0.4.5/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

communal-0.4.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 goodcleanfun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

communal-0.4.5/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.3
+Name: communal
+Version: 0.4.5
+Summary: A library of commonly used Python utilities and functions
+Project-URL: Homepage, https://github.com/goodcleanfun/communal
+Project-URL: Repository, https://github.com/goodcleanfun/communal
+Author: Al Barrentine
+License-Expression: MIT
+License-File: LICENSE
+Keywords: communal,utils
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Requires-Dist: chardet
+Requires-Dist: fsspec>=2022.3.0
+Requires-Dist: ftfy
+Requires-Dist: furl
+Requires-Dist: inflect
+Requires-Dist: pendulum
+Requires-Dist: python-dateutil
+Requires-Dist: pytz>=2022.1
+Requires-Dist: requests
+Requires-Dist: user-agents
+Description-Content-Type: text/markdown
+
+# communal
+A library of common Python utilities and functions

communal-0.4.5/README.md

@@ -0,0 +1,2 @@
+# communal
+A library of common Python utilities and functions

communal-0.4.5/communal/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.4.5"

communal-0.4.5/communal/attrdict.py

@@ -0,0 +1,16 @@
+class AttrDict(dict):
+    """
+    A dictionary that allows using the dot operator to get and set keys.
+    """
+
+    def __getattr__(self, key):
+        return self[key]
+
+    def __setattr__(self, key, value):
+        self[key] = value
+
+    def __delattr__(self, key):
+        del self[key]
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}({dict.__repr__(self)})"

communal-0.4.5/communal/binary.py

@@ -0,0 +1,79 @@
+import base64
+
+from communal.encoding import safe_decode, safe_encode
+from communal.functions import Pipeline
+from communal.properties import classproperty
+
+
+def int_to_bytes(x: int, endianness="little"):
+    if not isinstance(x, int):
+        x = int(x)
+    return x.to_bytes((x.bit_length() + 7) // 8, endianness)
+
+
+def int_from_bytes(x: bytes, endianness="little"):
+    return int.from_bytes(x, endianness)
+
+
+class BinaryEncoder(object):
+    @classmethod
+    def strip_padding(cls, s):
+        return s.rstrip(b"=")
+
+    @classproperty
+    def encode(cls):
+        return Pipeline(cls.encoder, cls.strip_padding)
+
+    @classmethod
+    def add_padding(cls, s):
+        return s if len(s) % cls.group_width == 0 else s.ljust(cls.group_width, b"=")
+
+    @classproperty
+    def decode(cls):
+        return Pipeline(cls.add_padding, cls.decoder)
+
+    @classmethod
+    def encode_str(cls, s: str):
+        return safe_decode(cls.encode(safe_encode(s)))
+
+    @classmethod
+    def encode_int(cls, x: int, endianness: str = "little"):
+        return safe_decode(cls.encode(int_to_bytes(x, endianness=endianness)))
+
+    @classmethod
+    def decode_str(cls, s: str):
+        return safe_decode(cls.decode(safe_encode(s)))
+
+    @classmethod
+    def decode_int(cls, s: str, endianness: str = "little"):
+        return int_from_bytes(cls.decode(safe_encode(s)), endianness=endianness)
+
+
+class Base16(BinaryEncoder):
+    bits = 16
+    group_width = 2
+    encoder = base64.b16encode
+    decoder = base64.b16decode
+
+
+class Base32(BinaryEncoder):
+    bits = 32
+    group_width = 8
+    encoder = base64.b32encode
+    decoder = base64.b32decode
+
+
+class Base64(BinaryEncoder):
+    bits = 64
+    group_width = 8
+    encoder = base64.b64encode
+    decoder = base64.b64decode
+
+
+class Base85(BinaryEncoder):
+    bits = 85
+    encoder = base64.b85encode
+    decoder = base64.b85decode
+
+    encode = encoder
+    decode = decoder

communal-0.4.5/communal/casing.py

@@ -0,0 +1,23 @@
+import re
+
+camel_to_snake_re_all_caps = re.compile("([A-Z\\d]+)([A-Z][a-z])")
+camel_to_snake_re_before_word = re.compile("([a-z])([A-Z])")
+
+
+def camel_to_snake_case(name):
+    name = camel_to_snake_re_all_caps.sub("\\1_\\2", name)
+    name = camel_to_snake_re_before_word.sub("\\1_\\2", name)
+    name = name.replace("-", "_")
+    return name.lower()
+
+
+def to_camel_case(name):
+    return name.title().replace(" ", "").replace("_", "")
+
+
+def to_title_case(name):
+    """Convert all upper or all lower case names to title case, otherwise preserve casing."""
+    if name.islower() or name.isupper():
+        return name.title()
+    else:
+        return name

communal-0.4.5/communal/client.py

@@ -0,0 +1,14 @@
+class ClientProxy(object):
+    client = None
+
+    def __getattr__(self, name):
+        return getattr(self.client, name)
+
+    def __getitem__(self, name):
+        return self.client[name]
+
+    def __setitem__(self, name, value):
+        self.client[name] = value
+
+    def __delitem__(self, name):
+        del self.client[name]

communal-0.4.5/communal/collections.py

@@ -0,0 +1,15 @@
+from collections import OrderedDict
+from collections.abc import Hashable, Mapping
+
+
+def unique_list(values):
+    """Produces a unique list while preserving input order"""
+    return list(OrderedDict.fromkeys(values))
+
+
+def is_mapping(val):
+    return isinstance(val, Mapping)
+
+
+def is_hashable(val):
+    return isinstance(val, Hashable)

communal-0.4.5/communal/dates.py

@@ -0,0 +1,26 @@
+from datetime import date, datetime
+
+from dateutil.parser import parse as _dateutil_parse
+
+
+def current_timestamp():
+    return datetime.utcnow().timestamp()
+
+
+def current_year():
+    return date.today().year
+
+
+parse_datetime = _dateutil_parse
+
+
+def parse_date(dt):
+    return _dateutil_parse(dt).date()
+
+
+def parse_datetime_ignore_tz_microseconds(d):
+    return _dateutil_parse(d, ignoretz=True)
+
+
+def parse_datetime_ignore_tz_seconds(d):
+    return _dateutil_parse(d, ignoretz=True).replace(microsecond=0)

communal-0.4.5/communal/download.py

@@ -0,0 +1,36 @@
+import os
+import shutil
+
+import fsspec
+import furl
+import requests
+
+from communal.files import ensure_dir
+
+
+def save_response_content(response, destination):
+    with fsspec.open(destination, "wb") as f:
+        shutil.copyfileobj(response.raw, f)
+
+
+def download_file(url, dest, retries=3, retry_delay=5, session=requests, headers=None):
+    url = furl.furl(url)
+
+    exists = os.path.exists(dest)
+    is_dir = os.path.isdir(dest) if exists else len(os.path.splitext(dest)[1]) == 0
+
+    base_dir = dest if is_dir else os.path.dirname(dest)
+    if base_dir:
+        ensure_dir(base_dir)
+
+    dest_filename = os.path.basename(dest) if not is_dir else None
+    if not dest_filename and url.path.isfile:
+        dest_filename = url.path.segments[-1]
+        dest = os.path.join(dest, dest_filename)
+
+    with session.get(url, headers=headers, stream=True) as resp:
+        resp.raw.decode_content = True
+        resp.raise_for_status()
+        save_response_content(resp, dest)
+
+    return dest

communal-0.4.5/communal/encoding.py

@@ -0,0 +1,34 @@
+def safe_decode(
+    value, encoding="utf-8", errors="strict", text_types=str, binary_types=bytes
+):
+    if isinstance(value, text_types):
+        return value
+
+    if isinstance(value, binary_types):
+        return value.decode(encoding, errors)
+    else:
+        return str(value)
+
+
+def safe_encode(
+    value,
+    encoding="utf-8",
+    from_encoding=None,
+    errors="strict",
+    text_types=str,
+    binary_types=bytes,
+):
+    if isinstance(value, text_types):
+        return value.encode(encoding, errors=errors)
+    elif isinstance(value, binary_types):
+        if hasattr(from_encoding, "lower"):
+            from_encoding = from_encoding.lower()
+        if hasattr(encoding, "lower"):
+            encoding = encoding.lower()
+
+        if value and from_encoding and encoding and encoding != from_encoding:
+            value = safe_decode(value, encoding=from_encoding, errors=errors)
+            return value.encode(encoding, errors)
+        return value
+    else:
+        return bytes(repr(value), encoding=encoding)

communal-0.4.5/communal/enum.py

@@ -0,0 +1,32 @@
+import enum
+
+
+class StringEnum(str, enum.Enum):
+    def __str__(self):
+        return str(self.value)
+
+    @classmethod
+    def display_name(cls, choice):
+        return choice.name
+
+    @property
+    def display(self):
+        return self.value.replace("_", " ").title()
+
+    @classmethod
+    def choices(cls):
+        return [(choice.value, cls.display_name(choice)) for choice in cls]
+
+    @classmethod
+    def from_value(cls, value):
+        return cls(value)
+
+
+class LabeledEnum(enum.Enum):
+    label: str
+
+    def __new__(cls, value, label):
+        obj = object.__new__(cls)
+        obj._value = value
+        obj.label = label
+        return obj

communal-0.4.5/communal/exceptions.py

@@ -0,0 +1,6 @@
+class ConfigurationError(Exception):
+    pass
+
+
+class DecoratorIncompatibilityError(ConfigurationError):
+    pass

communal-0.4.5/communal/files.py

@@ -0,0 +1,42 @@
+import os
+import shutil
+
+import fsspec
+
+from communal.sizes import COPY_BUFFER_SIZE
+
+
+def ensure_dir(d):
+    if not os.path.exists(d):
+        os.makedirs(d)
+
+
+def copy_file(filename, dest, buffer_size=COPY_BUFFER_SIZE):
+    dest_kwargs = {}
+    if dest.endswith(".gz") and not filename.endswith(".gz"):
+        dest_kwargs.update(compression="gzip")
+    elif dest.endswith(".zip") and not filename.endswith(".zip"):
+        dest_kwargs.update(compression="zip")
+
+    with fsspec.open(dest, "wb", **dest_kwargs) as df:
+        with fsspec.open(filename, "rb") as sf:
+            shutil.copyfileobj(sf, df)
+    return dest
+
+
+def remove_file(filename):
+    os.unlink(filename)
+
+
+class cd:
+    """Context manager for changing the current working directory"""
+
+    def __init__(self, path):
+        self.path = path
+
+    def __enter__(self):
+        self.saved_path = os.getcwd()
+        os.chdir(self.path)
+
+    def __exit__(self, etype, value, traceback):
+        os.chdir(self.saved_path)

communal-0.4.5/communal/floats.py

@@ -0,0 +1,5 @@
+import math
+
+FLOAT_EPSILON = 1e-09
+
+float_equals = math.isclose