https://github.com/luxuncang/typefire
基于类型注解的自定义类型转换，可用于拓展 fire 解析类型
https://github.com/luxuncang/typefire
fire-python hints
Last synced: about 10 hours ago
JSON representation
基于类型注解的自定义类型转换，可用于拓展 fire 解析类型
- Host: GitHub
- URL: https://github.com/luxuncang/typefire
- Owner: luxuncang
- License: mit
- Created: 2022-02-17T10:36:34.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-25T05:02:57.000Z (over 3 years ago)
- Last Synced: 2025-12-16T18:55:38.846Z (4 months ago)
- Topics: fire-python, hints
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeFire
[](https://www.codefactor.io/repository/github/luxuncang/typefire)
[](https://github.com/luxuncang/typefire/blob/master/LICENSE)
[](https://github.com/luxuncang/typefire/blob/main/.github/workflows/codeql-analysis.yml)
**通过装饰器零入侵性的，对 `fire-python` 的类型约束进行拓展，此外其还适用于任何函数对象进行基于注解的类型转换**
## 安装
```bash
pip install typefire
```
## 特性
- 支持注解类型转换
- 支持字符串类型注解
- 支持 async/await
- 零入侵性
- 支持任意对象
## Fire
```python
from pathlib import Path
import fire
def test_fire(path: Path):
print(type(path))
print(path)
if __name__ == "__main__":
fire.Fire(test_fire)
'''
python test_fire.py "/some_path_string"
/some_path_string
'''
```
ps: [fire #260](https://github.com/google/python-fire/issues/260#issue-620735435)
## TypeFire
```python
from typefire import Switch, TypeFire, typefire, typeswitch
import fire
import pathlib
TypeFire.add_switch(Switch(str, pathlib.Path, lambda p: pathlib.Path(p)))
@typeswitch
def main(path: pathlib.Path, *args, **kwargs):
print(path, type(path))
fire.Fire(main)
'''
python test_fire.py "/some_path_string"
/some_path_string
'''
```
```python
from typefire import Switch, TypeFire, typefire, typeswitch
import fire
import pathlib
TypeFire.add_switch(Switch(str, pathlib.Path, lambda p: pathlib.Path(p)))
@typefire
def main(path: pathlib.Path, *args, **kwargs):
print(path, type(path))
main("/some_path_string")
main("--path=/some_path_string")
```
## typeswitch
案例一：
```python
from typing import Union
def main(data: Union[bytes, Path, str]) -> bytes:
if isinstance(data, bytes):
...
elif isinstance(data, Path):
...
elif isinstance(data, str):
...
```
案例二：
```python
from typefire import Switch, typeswitch, TypeFire
from pathlib import Path
TypeFire.add_switch(Switch(str, bytes, lambda x: open(x, 'rb').read()))
TypeFire.add_switch(Switch(Path, bytes, lambda x: open(x, 'rb').read()))
@typeswitch()
def main(data: bytes):
print(type(data))
main(Path('test.py'))
main('test.py')
main(open('test.py', 'rb').read())
'''
'''
```
*显而易见 使用 `typeswitch` 显的更优雅，复用性更强*
qs: [test](./test/test_typefire.py)