ipython / ipython/traitlets

How to create required CLI config options?

Open
#828 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

In https://github.com/ipython/traitlets/issues/490 this issue was raised and then closed by @rmorshea.

However,
* [searching the docs for mandatory](https://traitlets.readthedocs.io/en/stable/search.html?q=mandatory#) yields nothing
* [searching the docs for required](https://traitlets.readthedocs.io/en/stable/search.html?q=required#) doesnt yield any relevant docs.

So:

1. How does one flag an attribute as mandatory?
2. Is this documented and did I miss it?

Here is a code sample for you to elide with what is necessary to make the `req` attribute mandatory:

```python

class App(Application):
optional_arg = Int(config=True)
req = Unicode(config=True)

```

I'm expecting an exception to be thrown when I invoke this app without providing req:

```
python my_app.py --App.optional_arg=5
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.