Add a "usage" session to nox

[ThomasLaPiana]

Closes #1618

Code Changes

• add a session for nox that prints the entire docstring for a given session

Steps to Confirm

• follow the examples given below and confirm everything works

Pre-Merge Checklist

• All CI Pipelines Succeeded Nothing here should affect any CI jobs or code logic
• Documentation Updated:
  • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
  • documentation issue created (tag docs-team to complete issue separately)
• Issue Requirements are Met
• Relevant Follow-Up Issues Created
• Update CHANGELOG.md

Description Of Changes

Using the standard nox command to list out all available sessions is nice and all, but it only shows the first line and isn't practical for showing in-depth information. Many session should contain a lot of usage information due to the complexity of the command given and this new session will allow us to do just that.

Example

No posargs provided

fides> nox -s usage 
Docker version 20.10.21, build baeda1f
nox > Running session usage
nox > Re-using existing virtual environment at .nox\usage.
nox > Session usage aborted: Please provide a session name.

Invalid session name provided

fides> nox -s usage -- foo
Docker version 20.10.21, build baeda1f
nox > Running session usage
nox > Re-using existing virtual environment at .nox\usage.
nox > Session usage aborted: Sorry, this isn't a valid nox session.

Valid session provided

fides> nox -s usage -- clean
Docker version 20.10.21, build baeda1f
nox > Running session usage
nox > Re-using existing virtual environment at .nox\usage.
nox > 
    Clean up docker containers, remove orphans, remove volumes
    and prune images related to this project.
    
nox > Session usage was successful.

[sanders41]

It's working for me, just one non-blocking question. How closely does this need to match to the output of nox? When running nox you get options like pytest_ops(unit).

Then nox -s usage -- pytest_ops(unit) gives missing delimiter for 'u' glob qualifier and nox -s usage -- "pytest_ops(unit)" gives Session usage aborted: Sorry, this isn't a valid nox session.. nox -s pytest_ops does work.

[TheAndrewJackson]

Everything worked as described. I'm also seeing what Paul mentioned. nox -s usage -- "build(dev)" is returning

Docker version 20.10.21, build baeda1f
nox > Running session usage
nox > Re-using existing virtual environment at .nox\usage.
nox > Session usage aborted: Sorry, this isn't a valid nox session.

I can see someone trying to test out that style of command. Maybe it would be possible to detect those sub commands and output the usage info for just that one. I agree that this is non blocking though 👍

[ThomasLaPiana]

It's working for me, just one non-blocking question. How closely does this need to match to the output of nox? When running nox you get options like pytest_ops(unit).

Then nox -s usage -- pytest_ops(unit) gives missing delimiter for 'u' glob qualifier and nox -s usage -- "pytest_ops(unit)" gives Session usage aborted: Sorry, this isn't a valid nox session.. nox -s pytest_ops does work.

This is expected behviour, as it is printing the docstring for a single session (which is a function). There aren't separate docstrings for each parameter, so one must use the session name directly without any specific parameters. nox -s pytest_ops is actually a valid session, it will run that session with each parameter.

For instance after I run a nox -s clean I then run nox -s build and it builds everything in one go