Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add nox.options which allows specifying command-line configuration in the Noxfile #145

Merged
merged 4 commits into from
Oct 12, 2018

Conversation

theacodes
Copy link
Collaborator

Closes #141

@dhermes, @lukesneeringer I would appreciate a critical eye here. I'm not 100% sold on the way I did this internally.

docs/config.rst Outdated

@nox.session
def tests(session):
pass
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put ... instead of pass?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


import nox

nox.options.sessions = ["lint", "tests-3.6"]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When does this get verified?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same place as the command-line arg, during tasks.filter_manifest -> manifest.filter_by_name. It'll barf if you pass garbage, ofc.


...

The following options can be specified in the Noxfile:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any plans for checking if this goes stale? Something like:

.. testsetup:: foo

    import nox
    def info(attr):
        return getattr(nox.options, attr).__doc__

.. doctest:: foo

    >>> names = sorted(dir(nox.options))
    >>> for name in names:
    ...     print(name)
    ...     print('    {}'.format(info(name))
    envdir
        Equivalent to specifying ...
    sessions
        Equivalent to specifying ...
    ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we're going to remain relatively conservative on adding new command line args (I say this as I'm writing a PR to add a new one...). I also don't have doctest setup yet, so.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also don't have doctest setup yet, so.

That's a bad reason?

But it's up to you. That was just a suggestion. You wouldn't get pretty CSS in a doctest. Or maybe it's possible, I just don't know how.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not a great reason to never do it, but it's a good reason not to do it right now. We can file a bug and pick it up later. (e.g. perfect being the enemy of good here, especially for collateral like documentation).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed. Feel free to file if you like the idea / if you want doctests. I love doctests and forbid code-block:: python in some projects (e.g. bezier)

docs/config.rst Show resolved Hide resolved
docs/config.rst Show resolved Hide resolved
@@ -110,7 +137,8 @@ def main():
)

secondary.add_argument(
"--envdir", default=".nox", help="Directory where nox will store virtualenvs."
"--envdir",
help="Directory where nox will store virtualenvs, this is .nox by default.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Why the removal of .nox as default?
  2. Setting formatter_class=argparse.ArgumentDefaultsHelpFormatter will actually document your defaults so you don't need to write it in your prose

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving .nox as default makes it impossible for me to tell if it was specified at the command line or not. Leaving it as "None" allows me to distinguish that, and the default assignment is moved into merge_from_options.

nox/__main__.py Outdated Show resolved Hide resolved
nox/tasks.py Show resolved Hide resolved
nox/_options.py Show resolved Hide resolved
nox/_options.py Show resolved Hide resolved
Copy link
Collaborator

@dhermes dhermes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@theacodes theacodes merged commit 24bb6ac into master Oct 12, 2018
@theacodes theacodes deleted the noxfile-options branch October 12, 2018 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants