Skip to main content

This project contains common and generic functions, decorators, interfaces and classes...

Project description

core-mixins

This project contains common functions, decorators, and mixin classes as the base for other projects or libraries…


Python Versions License Pipeline Status Docs Status Security

Installation

Install from PyPI using pip:

pip install core-mixins
uv pip install core-mixins  # Or using UV...

Features

This library provides the following modules and utilities:

Compatibility
  • Self - Type hint for self-referential classes

  • StrEnum - String enumeration compatibility across Python versions

Decorators (core_mixins.decorators)
  • cache - Memoization decorator with optional LRU eviction (maxsize)

  • count_calls / CountCalls - Track function call counts

  • repeat - Execute functions multiple times

  • retry - Automatic retry with configurable backoff

  • singleton - Enforce single instance pattern

  • SyncWrapper - Convert async functions to synchronous

  • with_timeout - Subprocess-based timeout, cross-platform, sub-second precision

  • with_timeout_signal - Signal-based timeout (Unix/Linux only), minimal overhead

  • timer - Measure function execution time

File Utilities (core_mixins.files)
  • records_from_csv / records_to_csv - CSV file handling

  • records_from_buffer / records_to_buffer - In-memory CSV operations

Interfaces (core_mixins.interfaces)
  • IFactory - Factory pattern interface

  • ITask - Task interface with status tracking

  • TaskStatus - Task state enumeration

  • TaskException - Task-specific exceptions

Managers (core_mixins.managers)
  • TasksManager - Manage and execute multiple tasks

  • TaskResult - Task execution result container

Logging (core_mixins.logger)
  • get_logger - Standardized logger configuration

Utilities (core_mixins.utils)
  • random_string - Generate random strings

  • get_batches - Batch list processing

  • remove_attributes / rename_attributes / add_attributes - Dictionary manipulation

  • convert_data_type - Type conversion utilities

  • to_snake_case - Convert strings to snake_case

  • flatten_json - Flatten nested JSON structures

  • to_one_line - Convert multiline strings to single line

  • bytes_to_str - Convert bytes to string

Exceptions (core_mixins.exceptions)
  • get_exception_data - Extract structured exception information

CLI Utilities (core_mixins.cli)
  • ProgressTracker - TTY-aware progress bar; animates on real terminals, falls back to logger.info on Lambda/ECS/CI. Built as a zero-dependency alternative to tqdm, keeping core-mixins dependency-free so it does not pull transitive packages into production services where supply-chain surface area and package size matter.

Quick Start

Installation

Install the package:

pip install core-mixins
uv pip install core-mixins  # Or using UV...
pip install -e ".[dev]"    # For development...

Setting Up Environment

  1. Install required libraries:

pip install --upgrade pip
pip install virtualenv
  1. Create Python virtual environment:

virtualenv --python=python3.12 .venv
  1. Activate the virtual environment:

source .venv/bin/activate

Install packages

pip install .
pip install -e ".[dev]"

Check tests and coverage

python manager.py run-tests                             # unit tests (default)
python manager.py run-tests -t integration              # integration tests
python manager.py run-tests -t functional -p "*.py"     # functional tests
python manager.py run-coverage                          # all tests with coverage

Contributing

Contributions are welcome! Please:

  1. Fork the repository

  2. Create a feature branch

  3. Write tests for new functionality

  4. Ensure all tests pass: python manager.py run-tests

  5. Run linting: pylint core_mixins

  6. Run security checks: bandit -r core_mixins

  7. Submit a pull request

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

For questions or support, please open an issue on GitLab or contact the maintainers.

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

core_mixins-3.1.3.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

core_mixins-3.1.3-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file core_mixins-3.1.3.tar.gz.

File metadata

  • Download URL: core_mixins-3.1.3.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for core_mixins-3.1.3.tar.gz
Algorithm Hash digest
SHA256 78330622dcf22ba02e632aae6154fe66c7f95246af84776d959c088f2c2d1564
MD5 73a5e3d88ef188d40d330981c0d40328
BLAKE2b-256 02fb6d0af27bf8a16c20fcd12926618da08c390607d7958a681461cae79cb8a0

See more details on using hashes here.

File details

Details for the file core_mixins-3.1.3-py3-none-any.whl.

File metadata

  • Download URL: core_mixins-3.1.3-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for core_mixins-3.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 76304a1fbc5f1fc98283407c7b65b6107b64b966d9d7bef6bcccfcaa14f2b615
MD5 aee0c17aab76e630a20d497306c0dc80
BLAKE2b-256 a53968cb4af40e7a4684c1094c517f3e028a78d14122d79e358c920c1027f79a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page