Welcome to play python’s documentation!¶

Contents:

play python¶

pytest-play plugin with restricted Python expressions and assertions and it is based on the RestrictedPython package.

RestrictedPython is a tool that helps to define a subset of the Python language which allows to provide a program input into a trusted environment. RestrictedPython is not a sandbox system or a secured environment, but it helps to define a trusted environment and execute untrusted code inside of it.

See:

https://github.com/zopefoundation/RestrictedPython

More info and examples on:

pytest-play, documentation
cookiecutter-qa, see pytest-play in action with a working example if you want to start hacking

Features¶

This project defines the following pytest-play commands based on Python expressions.

Store variables¶

You can store a pytest-play variables:

{
 'provider': 'python',
 'type': 'store_variable',
 'expression': '1+1',
 'name': 'foo'
}

Make a Python assertion¶

You can make an assertion based on a Python expression:

{
 'provider': 'python',
 'type': 'assert',
 'expression': 'variables["foo"] == 2'
}

Sleep¶

Sleep for a given amount of seconds:

{
 'provider': 'python',
 'type': 'sleep',
 'seconds': 2
}

Exec a Python expresssion¶

You can execute a Python expression:

{
 'provider': 'python',
 'type': 'exec',
 'expression': 'variables.update({'play_requests': {'parameters': {'headers': {'Authorization': '$bearer', 'Content-Type': 'application/json'}}}})'
}

Twitter¶

pytest-play tweets happens here:

@davidemoro

Credits¶

This package was created with Cookiecutter and the cookiecutter-play-plugin (based on audreyr/cookiecutter-pypackage project template).

Installation¶

Stable release¶

To install play python, run this command in your terminal:

$ pip install play_python

This is the preferred method to install play python, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for play python can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/tierratelematics/play_python

Or download the tarball:

$ curl  -OL https://github.com/tierratelematics/play_python/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/tierratelematics/play_python/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

play python could always use more documentation, whether as part of the official play python docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/tierratelematics/play_python/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up play_python for local development.

Fork the play_python repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/play_python.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv play_python
$ cd play_python/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 play_python tests
$ python setup.py test or py.test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/tierratelematics/play_python/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test tests.test_play_python

CHANGES¶

0.0.1 (unreleased)¶

Nothing changed yet.