Skip to main content

Runtime language extensions and validation tools for Python

Project description

LangEx

Extended Language Support for Python

Dynamic JSON Badge Sponsor

Installation

pip install langex

About

LangEx is an evolving Python library that introduces additional language-level constructs using decorators, metadata inspection, and runtime validation.

It focuses on enabling capabilities that Python does not strictly enforce by default, such as interface-like structures, structured metadata, and runtime type validation.

The project builds small language utilities that operate on Python objects (functions, classes, and other callables) to inspect, validate, and extend their behavior while remaining fully compatible with standard Python.

Features

  • Interface-like constructs for Python classes
  • Metadata extraction for Python objects and callables
  • Utility classes like Singleton
  • Runtime validation utilities
  • Decorator-based language extensions
  • Runtime argument and return type checking
  • Lightweight core inspection tools
  • An abstracted testing toolkit
  • Simple pipeline construction utilities

Example

Defining and using an Interface

from langex.core.classes import implements, interface
from langex.core.functions import args_required, returns

@interface
class InterfaceClass:
  @args_required(int)
  @returns(int)
  def method1(self, a: int) -> int:
    ...

  @args_required(str)
  @returns(str)
  def method2(self, b: str) -> str:
    ...

@implements(InterfaceClass)
class ImplementationClass:
  def __init__(self, factor):
    self.factor = factor

  def method1(self, a: int) -> int:
    return a * self.factor

  def method2(self, b: str) -> str:
    return b.upper() * self.factor

instance = ImplementationClass(3)
print(instance.method1(5)) # prints 15 in console
print(instance.method2("hi")) # prints "HIHIHI" in console
print(instance.method1("5")) # raises Langex Validation Error
print(instance.method2(5)) # raises Langex Validation Error

Runtime Type Enforcement

from langex.core.functions import args_required, returns

@args_required(int, int)
@returns(int)
def add(a, b):
  return a + b

print(add(1, 2)) # prints the integer 3 in console
print(add("1", "2")) # raises Langex Validation Error

Singleton Class Example

from langex.core.classes import singleton

@singleton
class IdGenerator:
  def __init__(self, initial = 0):
    self.value = initial

  def next_id(self):
    self.value += 1
    return self.value

id_gen1 = IdGenerator()
id_gen2 = IdGenerator()

print(id_gen1.next_id()) # prints 1 in console
print(id_gen1.next_id()) # prints 2 in console
print(id_gen2.next_id()) # prints 3 in console

print(id_gen1 is id_gen2) # prints True in console

Pipelines

from langex.core.pipeline import Pipeline

process1 = lambda incoming: 1 if incoming is None else incoming
process2 = lambda incoming: incoming * 2
process3 = lambda incoming: incoming + 2

pipeline = (
  Pipeline
  | process1
  | process2
  | process3
)

print(pipeline.run()) # prints 4 in console
print(pipeline.run(10)) # prints 22 in console

Project Structure

langex
├── __init__.py
├── __main__.py
├── classes
│   ├── __init__.py
│   ├── class_meta.py
│   ├── methods_meta.py
│   └── singleton.py
├── constants
│   ├── __init__.py
│   ├── contents.py
│   ├── keys.py
│   └── labels.py
├── core
│   ├── __init__.py
│   ├── classes.py
│   ├── errors.py
│   ├── functions.py
│   ├── pipeline.py
│   └── testing.py
├── errors
│   ├── __init__.py
│   ├── instantiation.py
│   ├── langex.py
│   ├── misapplication.py
│   ├── unimplemented.py
│   └── validation.py
├── functions
│   ├── __init__.py
│   ├── args_meta.py
│   ├── function_meta.py
│   ├── returns_meta.py
│   ├── signature_parser.py
│   └── signature.py
├── pipelines
│   ├── __init__.py
│   └── handler.py
├── testing
│   ├── __init__.py
│   ├── data.py
│   └── helpers.py
├── utils
│   ├── __init__.py
│   ├── extracter.py
│   └── matcher.py
└── validation
    ├── __init__.py
    ├── kw_args_validator.py
    ├── pos_args_validator.py
    ├── returns_validator.py
    └── validator.py

Module Overview

  • The core module contains the core decorators and utilities for language extensions.
  • The constants module contains constant strings and keys used across the project for metadata, attributes and validation.
  • The classes module contains tools for class inspection and interface-like constructs.
  • The functions module contains tools for function metadata and signature inspection.
  • The validation modules contain logic for validating function arguments and return values at runtime.
  • The utils module contains helper functions for type matching and other utilities.
  • The errors module defines custom exceptions for validation and other errors.

Design Philosophy

LangEx is designed around a few principles:

  • Pure Python implementation
  • Explicit developer intent
  • Small composable language utilities

Rather than acting as a framework, LangEx provides foundational language tools that can be used to build higher-level abstractions.

Status

LangEx is currently in the evolution stage, with a growing set of language utilities and features. The project is actively maintained and open to contributions.

It is no longer in experimental alpha phase, but is still considered to be unstable for some use cases. It is recommended to use it in non-critical projects or for experimentation until it reaches a more stable release.

Once applications and projects using LangEx start performing reliably in production environments, the project will be considered mature and stable enough for wider adoption, with a 1.0.0 release.

Links

Contributors

Support

If you find this project useful, please consider supporting it by starring the GitHub repository or sharing it with others who might benefit from it.

Your support helps in the continued development and improvement of the project.

You can also contribute to the project by submitting issues, suggesting features, or even contributing code through pull requests.

You can also sponsor the project on GitHub Sponsors: GitHub Sponsors - AttAditya


Made with <3 by AttAditya

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

langex-0.4.2.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

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

langex-0.4.2-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file langex-0.4.2.tar.gz.

File metadata

  • Download URL: langex-0.4.2.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for langex-0.4.2.tar.gz
Algorithm Hash digest
SHA256 19a3714a8b244d50f508aa98f628e5d0f4df3304e26948491314fa9af7563863
MD5 31c5d49a7d44e5d809fb47ac21cd7569
BLAKE2b-256 97a6686f9751652f2a4a5e0b0eeecef0940d5c8607f5aef650377bdcd95356a3

See more details on using hashes here.

File details

Details for the file langex-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: langex-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for langex-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a4add1d42eff0295bb286e5fbe8b961a71c053bcebd42faea4b6f5ac0c3354a5
MD5 33ba49f2617f6550c0f196cee2c1d495
BLAKE2b-256 7a83dc6e1e2ef528c169c17fb7f8a220ea2c42347879fe35f7f842b340c98c2c

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