https://github.com/epicstuff/python-epicstuff
A few somewhat useful (Epic) python objects/functions (Stuff)
https://github.com/epicstuff/python-epicstuff
helper pypi python python-library python3
Last synced: about 1 month ago
JSON representation
A few somewhat useful (Epic) python objects/functions (Stuff)
- Host: GitHub
- URL: https://github.com/epicstuff/python-epicstuff
- Owner: EpicStuff
- License: other
- Created: 2024-01-31T19:16:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-05T17:24:23.000Z (over 1 year ago)
- Last Synced: 2025-03-11T04:17:35.463Z (11 months ago)
- Topics: helper, pypi, python, python-library, python3
- Language: Python
- Homepage: https://pypi.org/project/epicstuff/
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EpicStuff
A few somewhat useful (Epic) python objects/functions (Stuff)
## Installation
```bash
pip install epicstuff
```
## Bar
Makes using nested progress bars from rich.progress easier
- Example:
basically replaces
```python
from rich.progress import Progress
with Progress() as progress:
task = progress.add_task("task", total=100)
for i in range(100):
sub_task = progress.add_task("subtask", total=100)
for j in range(100):
time.sleep(0.01) # some task
progress.update(sub_task, advance=1)
progress.remove_task(sub_task)
progress.update(task, advance=1)
```
with
```python
from epicstuff import Bar
with Bar() as bar:
for i in bar(range(100)):
for j in bar(range(100), transient=True):
time.sleep(0.01) # some task
```
with minor extra features (fancier default bar)
## Dict
Lets you access a dictionary's keys as attributes
### new version
Simpler than [`Box`](https://pypi.org/project/python-box/) (and faster i think) and with more features (basically only recursive conversion) than [`jdict`](https://pypi.org/project/pyjdict/) (and without some of the "extra" stuff)
- Example:
```python
from epicstuff import Dict
d = Dict({"a": 1, "b": {"c": 2, "d": 3}})
print(d.b.c) # 2
```
### old version
Points to a target instead of converting it into a (new) `Dict` object. Useful for when your "target" is say, a `CommentedMap` and you don't want to loose the comments
- Example:
```python
from epicstuff import Dict
d = Dict({}, _convert=False)
d.x = 1
```
## s
An autoformatting string. Removes extra indent and leading/trailing newlines.
- Example:
```python
from epicstuff import s
string = s('''
line 1
line 2
line 3
''') + 'line 4'
print(s)
# line 1
# line 2
# line 3
# line 4
```
## Rich Trace
Easily install terminal-wide `rich.traceback` and use helpers to ensure pretty tracebacks.
- Example:
```python
from epicstuff import run_install_trace
```
- or:
```python
from epicstuff import rich_trace
@rich_trace
async def some_func():
raise Exception
some_func()
```
- or:
```python
@rich_trace(_return=0)
async def some_func():
raise Exception
some_func()
```
- or:
```python
with rich_trace():
raise Exception
```
## Permissify
make function ignore extra arguments instead of raising an error.
- Example:
```python
from epicstuff import perm
def tmp(a, b=2): ...
perm(tmp)(1, 2, b=3, c=5) # this will run without raising TypeError
```
## Timer
a simple timer to time execution of code a code segment
- Example:
```python
from epicstuff import timer
with timer():
pass # some code
# outputs: Time elapsed: 0.0 seconds
# message can be changed by passing a string with {} to timer
```
## Stuff
extra functions:
- `open`: overwriting `open` with `Path.open` and `encoding='utf8'`
- `wrap`: just a renamed `functools.partial`
- `rmap`: `map` but recursive for lists and dicts
- takes `list` or `dict` and 2 functions, will apply function 1 to all keys and function 2 to all values
## TODO:
- [ ] when doing bar in bar with the second bar being transient, make so that the dots continue from where the previous bar left off
- [ ] implement auto transient for bar in bar
- [ ] add and implement simple=False for .Bar.track()
- [ ] when Dict()._create is True, getitem should maybe also return either None or empty Dict
## Stuff:
- Note to self:
- "self install" using `pip install -U -e .`
- upload by running `python -m build` then `twine upload --skip-existing dist/*`