Skip to content

Commit d9fae43

Browse files
committed
linting and docstring fixes
1 parent 4ebd4f0 commit d9fae43

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

src/xulbux/console.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ def __eq__(self, other: object) -> bool:
7676
if not isinstance(other, ParsedArgData):
7777
return False
7878
return (
79-
self.exists == other.exists and self.values == other.values and self.is_pos == other.is_pos
79+
self.exists == other.exists \
80+
and self.is_pos == other.is_pos
81+
and self.values == other.values
8082
and self.flag == other.flag
8183
)
8284

@@ -261,30 +263,30 @@ class Console(metaclass=_ConsoleMeta):
261263
def get_args(cls, arg_parse_configs: ArgParseConfigs, flag_value_sep: str = "=") -> ParsedArgs:
262264
"""Will search for the specified args in the command-line arguments
263265
and return the results as a special `ParsedArgs` object.\n
264-
--------------------------------------------------------------------------------------
266+
-------------------------------------------------------------------------------------------------
265267
- `arg_parse_configs` - a dictionary where each key is an alias name for the argument
266268
and the key's value is the parsing configuration for that argument
267269
- `flag_value_sep` - the character/s used to separate flags from their values\n
268-
--------------------------------------------------------------------------------------
270+
-------------------------------------------------------------------------------------------------
269271
The `arg_parse_configs` dictionary can have the following structures for each item:
270272
1. Simple set of flags (when no default value is needed):
271-
```python
273+
```python
272274
"alias_name": {"-f", "--flag"}
273-
```
275+
```
274276
2. Dictionary with the`"flags"` set, plus a specified `"default"` value:
275-
```python
277+
```python
276278
"alias_name": {
277279
"flags": {"-f", "--flag"},
278280
"default": "some_value",
279281
}
280-
```
282+
```
281283
3. Positional value collection using the literals `"before"` or `"after"`:
282-
```python
284+
```python
283285
# COLLECT ALL NON-FLAGGED VALUES THAT APPEAR BEFORE THE FIRST FLAG
284286
"alias_name": "before"
285287
# COLLECT ALL NON-FLAGGED VALUES THAT APPEAR AFTER THE LAST FLAG'S VALUE
286288
"alias_name": "after"
287-
```
289+
```
288290
#### Example usage:
289291
If you call the `get_args()` method in your script like this:
290292
```python
@@ -313,7 +315,7 @@ def get_args(cls, arg_parse_configs: ArgParseConfigs, flag_value_sep: str = "=")
313315
text_after = ParsedArgData(exists=True, is_pos=True, values=["Goodbye"], flag=None),
314316
)
315317
```
316-
--------------------------------------------------------------------------------------
318+
-------------------------------------------------------------------------------------------------
317319
NOTE: Flags can ONLY receive values when the separator is present
318320
(e.g. `--flag=value` or `--flag = value`)."""
319321
if not flag_value_sep:

0 commit comments

Comments
 (0)