Skip to main content

A little language for schema-enforced models

Fame is a framework for metamodelling in Python.

  • Entities are described by models

  • Models are described by metamodels

  • Models have fields, derived fields and constraints

  • Entities can have custom fields

  • Entities can be created even if data is invalid

  • There are functions to validate and get error messages

  • Validation checks presence and type of fields

  • Validation checks all constraints

  • Derived fields are memoized

Example

class Experiment(Model):

    @schema
    def metamodel(self, m):
        m.field('name', str)
        m.field('subject', options(
            'user',
            'visitor',
            'email',
            'listing',
            'market'
        ))
        m.field('treatments', array(str))
        m.field('percent_exposed', int, default=100)
        m.field('design', nullable(regexp('^https?')))

    @derived_field
    def is_miscellanous(self):
        return self.subject not in ['user', 'visitor']

    @constraint("expected percent_exposed to not exceed 100, got {}")
    def constraint(self):
        if self.percent_exposed > 100:
            return self.percent_exposed

Conventions

  • Define metamodel function first

  • Then define derived field functions

  • Then define all the constraint functions

  • Constraint functions are all named “constraint”, that is intentional

Installation

To install this package, run

pip install fame

Contributing

Bug reports and pull requests are welcome on github at, https://github.com/akuhn/py-fame

Release files for fame 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fame 1.2.0
File Size Uploaded
fame-1.2.0.tar.gz 3.7 kB Details

Release files / fame-1.2.0.tar.gz

Download URL fame-1.2.0.tar.gz
Size 3.7 kB
Tags Source
SHA-256 checksum
How to use checksums
54a8f05afc7b0e9356eb8b91744e6f5c02e4e55e72438a2de6c8b42444eea26c
BLAKE2b-256 checksum
How to use checksums
9f74e38c0d85a729266e87a903ddb4f759d60a1b97d14c2add32a756cf301068
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.10.0 pkginfo/1.4.2 requests/2.9.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.19.8 CPython/2.7.10

Release history Release notifications | RSS feed

This release

1.2.0 This release

1 release file

1.1.0

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page