Welcome to the xonsh developer's guide! This is a place for developers to place information that does not belong in the user's guide or the library reference but is useful or necessary for the next people that come along to develop xonsh.
Note
All code changes must go through the pull request review procedure.
Note
xonsh requires at least pip 24.0 for pyproject.toml support. You can upgrade old versions using pip install -U pip.
First, install xonsh from source and open a xonsh shell in your favorite terminal application. See installation instructions for details, but it is recommended to do an 'editable' install via `pip'
$ pip install -e .[dev]
Next, make a trivial change (e.g. print("hello!") in main.py).
Finally, run the following commands. You should see the effects of your change
(e.g. hello!):
$ $XONSH_DEBUG=1 $ xonsh
Pull requests will often have CHANGELOG entries associated with. However, to avoid excessive merge conflicts, please follow the following procedure:
Go into the
news/directory,Copy the
TEMPLATE.rstfile to another file in thenews/directory. We suggest using the branchname:@ cp TEMPLATE.rst branch.rst
Add your entries as a bullet pointed lists in your
branch.rstfile in the appropriate category. It is OK to leave theNoneentries for later use.Commit your
branch.rst.
Feel free to update this file whenever you want! Please don't use someone
else's file name. All of the files in this news/ directory will be merged
automatically at release time. The None entries will be automatically
filtered out too!
xonsh is a pure Python project, and so we use PEP8 (with some additions) to ensure consistency throughout the code base.
It is important to refer to things and concepts by their most specific name. When writing xonsh code or documentation please use technical terms appropriately. The following rules help provide needed clarity.
- User-facing APIs should be as generic and robust as possible.
- Tests belong in the top-level
testsdirectory. - Documentation belongs in the top-level
docsdirectory.
- Code must have associated tests and adequate documentation.
- User-interaction code (such as the Shell class) is hard to test. Mechanism to test such constructs should be developed over time.
- Have extreme empathy for your users.
- Be selfish. Since you will be writing tests you will be your first user.
xonsh follows PEP8 for all Python code. The following rules apply where PEP8 is open to interpretation.
Use absolute imports (
import xonsh.tools) rather than explicit relative imports (import .tools). Implicit relative imports (import tools) are never allowed.We use sphinx with the numpydoc extension to autogenerate API documentation. Follow the `numpydoc`_ standard for docstrings.
Simple functions should have simple docstrings.
Lines should be at most 80 characters long. The 72 and 79 character recommendations from PEP8 are not required here.
All Python code should be compliant with Python 3.8+.
Tests should be written with pytest using a procedural style. Do not use unittest directly or write tests in an object-oriented style.
Test generators make more dots and the dots must flow!
We use pre-commit for linting (ruff-lint) and formatting(ruff-format) the code. To enable this as a git pre-commit hook:
@ pre-commit install
xonsh imports should be sorted alphabetically, and by module location. You
can (and should) use isort either from the command line or use the
pre-commit hook.
If you want to run your "work in progress version" without installing and in a fresh environment you can use Docker. If Docker is installed you just have to run this:
@ python xonsh-in-docker.py
This will build and run the current state of the repository in an isolated container (it may take a while the first time you run it). There are two additional arguments you can pass this script.
- The version of python
- the version of
prompt_toolkit
Example:
@ python docker.py 3.4 0.57
Ensure your cwd is the root directory of the project (i.e., the one containing the .git directory).
Prep your environment for running the tests:
@ pip install -e '.[dev]'
Run all the tests using pytest:
@ pytest -q
Use "-q" to keep pytest from outputting a bunch of info for every test.
To perform all unit tests:
@ pytest
If you want to run specific tests you can specify the test names to execute. For example to run test_aliases:
@ pytest test_aliases.py
Note that you can pass multiple test names in the above examples:
@ pytest test_aliases.py test_environ.py
(refer to pytest documentation)
With the Pytest framework you can use bare assert statements on anything you're trying to test, note that the name of the test function has to be prefixed with test_:
def test_whatever():
assert is_true_or_false
The conftest.py in tests directory defines fixtures for mocking various parts of xonsh for more test isolation. For a list of the various fixtures:
@ pytest --fixtures
when writing tests it's best to use pytest features i.e. parametrization:
@pytest.mark.parametrize('env', [test_env1, test_env2])
def test_one(env, xession):
# update the environment variables instead of setting the attribute
# which could result in leaks to other tests.
# each run will have the same set of default env variables set.
xession.env.update(env)
...
this will run the test two times each time with the respective test_env. This can be done with a for loop too but the test will run only once for the different test cases and you get less isolation.
With that in mind, each test should have the least assert statements, preferably one.
At the moment, xonsh doesn't support any pytest plugins.
Happy Testing!
Documentation takes many forms. This will guide you through the steps of successful documentation.
No matter what language you are writing in, you should always have documentation strings along with you code. This is so important that it is part of the style guide. When writing in Python, your docstrings should be in reStructured Text using the `numpydoc`_ format.
The docstrings that you have written will automatically be connected to the
website, once the appropriate hooks have been setup. At this stage, all
documentation lives within xonsh's top-level docs directory.
We uses the sphinx tool to manage and generate the documentation, which
you can learn about from the sphinx website.
If you want to generate the documentation, first xonsh itself must be installed
and then you may run the following command from the docs dir:
~/xonsh/docs @ make htmlFor each new
module, you will have to supply the appropriate hooks. This should be done the
first time that the module appears in a pull request. From here, call the
new module mymod. The following explains how to add hooks.
Python API documentation is generated for the entries in docs/api.rst.
sphinx-autosummary
is used to generate documentation for the modules.
Mention your module mymod under appropriate header.
This will discover all of the docstrings in mymod and create the
appropriate webpage.
Building the website/documentation requires the following dependencies:
Note that xonsh itself needs to be installed too.
If you have cloned the git repository, you can install all of the doc-related dependencies by running:
@ pip install -e ".[doc]"
The xonsh website source files are located in the docs directory.
A developer first makes necessary changes, then rebuilds the website locally
by executing the command:
@ make html
This will generate html files for the website in the _build/html/ folder.
There is also a helper utility in the docs/ folder that will watch for changes and automatically rebuild the documentation. You can use this instead of running make html manually:
@ python docs/serve_docs.py
The developer may view the local changes by opening these files with their favorite browser, e.g.:
@ firefox _build/html/index.html
Once the developer is satisfied with the changes, the changes should be committed and pull-requested per usual. The docs are built and deployed using GitHub Actions.
Docs associated with the latest release are hosted at
https://xon.sh while docs for the current main branch are available at
https://xon.sh/dev
Mainline xonsh development occurs on the main branch. Other branches
may be used for feature development (topical branches) or to represent
past and upcoming releases.
You can cleanup your local repository of transient files such as *.pyc files created by unit testing by running:
@ rm -f xonsh/parser_table.py xonsh/completion_parser_table.py @ rm -f xonsh/*.pyc tests/*.pyc @ rm -fr build
This is done through the rever. To get a list of the valid options use:
@ pip install re-ver
You can perform a full release:
@ rever check @ rever <version-number>
Most of the time, an actual VM machine is needed to test the nuances of cross platform testing. But alas here are some other ways to test things
- Windows
- wine can be used to emulate the development environment. It provides cmd.exe with its default installation.
- OS X
- darlinghq can be used to emulate the development environment for Linux users. Windows users can use Linux inside a virtual machine or WSL to run the same.
- OSX KVM <https://github.com/kholia/OSX-KVM> can be used for virtualization.
- Linux
- It far easier to test things for Linux. docker is available on all three platforms.
One can leverage the Github Actions to provide a reverse shell to test things out. Solutions like actions-tmate are available, but they should not in any way violate the Github Action policies.
Portions of this page have been forked from the PyNE documentation, Copyright 2011-2015, the PyNE Development Team. All rights reserved.