Skip to main content

Generic object interface

Project description

Test status code coverage audobject's documentation audobjects's supported Python versions audfactory's MIT license

Generic interface for serializing objects to yaml.

Have a look at the installation and usage instructions.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Version 0.7.0 (2022-03-18)

  • Added: argument auto_install to audobject.from_dict(), audobject.from_yaml(), audobject.from_yaml_s()

  • Added: audobject.define.PackageMismatchWarnLevel

  • Added: audobject.config.PACKAGE_MISMATCH_WARN_LEVEL

  • Changed: store package in YAML if it does not match module

  • Changed: by default raises warning if required package has a newer version than the installed one

  • Removed: deprecation warning for ignore_vars from audobject.init_decorator()

Version 0.6.2 (2022-01-04)

  • Added: Python 3.9 support

  • Added: docstring examples to resolver classes

  • Changed: update documentation on borrowed arguments

  • Removed: Python 3.6 support

Version 0.6.1 (2021-10-26)

  • Added: argument override_args to from_dict(), from_yaml(), from_yaml_s()

  • Changed: resolver.Function supports callable objects of type Object

  • Deprecated: **kwargs from from_dict(), from_yaml(), from_yaml_s()

Version 0.6.0 (2021-10-08)

  • Added: subpackage resolver

  • Added: resolver.FilePath, resolver.Function, resolver.Tuple, resolver.Type

  • Deprecated: FilePathResolver, FunctionResolver, TupleResolver, TypeResolver

  • Fixed: preserve default arguments in serialized functions

  • Fixed: attach source to dynamically created functions

Version 0.5.1 (2021-10-04)

  • Added: audobject.FunctionResolver

Version 0.5.0 (2021-09-30)

  • Added: audobject.from_dict

  • Added: audobject.from_yaml

  • Added: audobject.from_yaml_s

  • Deprecated: audobject.Object.from_dict

  • Deprecated: audobject.Object.from_yaml

  • Deprecated: audobject.Object.from_yaml_s

Version 0.4.14 (2021-07-15)

  • Added: FilePathResolver

Version 0.4.13 (2021-04-07)

  • Fixed: inherit borrow, hide and resolvers

Version 0.4.12 (2021-03-26)

  • Fixed: link “Edit on Github” in documentation

  • Fixed: link to audfactory.Lookup in documentation

Version 0.4.11 (2021-03-24)

  • Fixed: remove footer links in documentation

Version 0.4.10 (2021-03-24)

  • Changed: add badges to README

  • Fixed: updated all links to Github

Version 0.4.9 (2021-03-24)

  • Fixed: package metadata defined in setup.cfg

Version 0.4.8 (2021-03-24)

  • Changed: move to Github and make open source release

Version 0.4.7 (2021-01-22)

  • Changed: audobject.Object implements __hash__()

  • Changed: borrow arguments from dictionary

Version 0.4.6 (2020-12-04)

  • Fixed: avoid warnings for unsupported kwargs in audobject.Object.from_dict()

Version 0.4.5 (2020-12-04)

  • Added: borrow argument to audobject.init_decorator()

Version 0.4.4 (2020-12-03)

  • Changed: parse authors and project name from setup

  • Changed: use audeer.deprecated_keyword_argument()

Version 0.4.3 (2020-11-06)

  • Changed: raise error when serializing a callable

Version 0.4.2 (2020-10-23)

  • Changed: better error messages

  • Changed: audobject.init_decorator() stores hidden arguments before calling __init__

Version 0.4.1 (2020-10-21)

  • Added: argument flatten to audobject.Object.to_dict()

Version 0.4.0 (2020-10-19)

  • Added: audobject.Object.arguments(), audobject.Object.hidden_arguments(), audobject.Object.resolvers()

  • Added: hide to audobject.init_decorator() (replaces ignore_vars)

  • Changed: Serialize only arguments of __init__ to YAML

  • Changed: Raise error if user tries to hide argument without default value

  • Changed: Raise error if argument that is not hidden is not assigned to a variable

  • Removed: check_vars from audobject.init_decorator

Version 0.3.3 (2020-10-09)

  • Fixed: dependency to audeer

Version 0.3.2 (2020-10-08)

  • Fixed: support empty dictionary

Version 0.3.1 (2020-10-08)

  • Changed: replace override_vars with kwargs

Version 0.3.0 (2020-10-08)

  • Added: option to ignore variables

  • Added: option to override variables

  • Changed: change sanity_check=True to check_vars=False

Version 0.2.0 (2020-10-08)

  • Added: audobject.init_decorator()

  • Added: audobject.Dictionary

Version 0.1.0 (2020-10-02)

  • Added: initial release

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

audobject-0.7.0.tar.gz (38.2 kB view details)

Uploaded Source

Built Distribution

audobject-0.7.0-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file audobject-0.7.0.tar.gz.

File metadata

  • Download URL: audobject-0.7.0.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for audobject-0.7.0.tar.gz
Algorithm Hash digest
SHA256 7f71c3283da8448da7e4b26bffddc6b1333bb676e588c48fd67f1f36bdce62f0
MD5 53d4b3db1452ac14b2d54aacb5abf39c
BLAKE2b-256 ad1845fe54e64bacfd7ef409c565e69a5b0e9e190c58b00baa6cede3a4a436a5

See more details on using hashes here.

File details

Details for the file audobject-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: audobject-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for audobject-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7dc7c21219695893172a6470d32ace3960607cd8608f8b0de9ff1fca0243327d
MD5 9ea8d2426dfa1edbabeee9094cea53c1
BLAKE2b-256 0a9bfcfa7aa2491dc1a535a5d2e290ac0de3c2eda9b1da93ca45b9eadbd9f938

See more details on using hashes here.

Supported by

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