properties
Project description
Overview Video
An overview of Properties, November 2016.
Why
Giving structure (and documentation!) to the properties you use in your classes avoids confusion and allows users to interact flexibly and provide multiple styles of input, have those inputs validated, and allow you as a developer to set expectations for what you want to work with.
Scope
The properties
package allows you to create strongly typed objects in a
consistent way. This allows you to hook into notifications and other libraries.
Goals
Keep a clean name space so that it can be used easily by users
Prioritize documentation
Connect to other libraries for interactive visualizations
Alternatives
Connections
steno3d for the client API
Installation
To install the repository, ensure that you have pip installed and run:
pip install properties
For the development version:
git clone https://github.com/3ptscience/properties.git
cd properties
pip install -e .
Examples
Lets start by making a class to organize your coffee habits.
import properties
class CoffeeProfile(properties.HasProperties):
name = properties.String('What should I call you?')
count = properties.Integer(
'How many coffees have you had today?',
default=0
)
had_enough_coffee = properties.Bool(
'Have you had enough coffee today?',
default=False
)
caffeine_choice = properties.StringChoice(
'How do you take your caffeine?' ,
choices=['coffee', 'tea', 'latte', 'cappuccino', 'something fancy'],
required=False
)
The CoffeeProfile
class has 4 properties, all of which are documented!
These can be set on class instantiation:
profile = CoffeeProfile(name='Bob')
print(profile.name)
Out [1]: Bob
Since a default value was provided for had_enough_coffee
, the response is (naturally)
print(profile.had_enough_coffee)
Out [2]: False
We can set Bob’s caffeine_choice
to one of the available choices; he likes coffee
profile.caffeine_choice = 'coffee'
Also, Bob is half way through his fourth cup of coffee today:
profile.count = 3.5
Out [3]: ValueError: The 'count' property of a CoffeeProfile instance must
be an integer.
Ok, Bob, chug that coffee:
profile.count = 4
Now that Bob’s CoffeeProfile
is established, properties
can
check that it is valid:
profile.validate()
Out [4]: True
Property Classes are auto-documented in Sphinx-style reStructuredText!
When you ask for the doc string of CoffeeProfile
, you get
**Required**
:param count: How many coffees have you had today?, an integer, Default: 0
:type count: :class:`Integer <properties.basic.Integer>`
:param had_enough_coffee: Have you had enough coffee today?, a boolean, Default: False
:type had_enough_coffee: :class:`Bool <properties.basic.Bool>`
:param name: What should I call you?, a string
:type name: :class:`String <properties.basic.String>`
**Optional**
:param caffeine_choice: How do you take your caffeine?, any of "something fancy", "tea", "coffee", "cappuccino", "latte"
:type caffeine_choice: :class:`StringChoice <properties.basic.StringChoice>`
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.