| Name | thinking-modules JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Module-related python utilities - recursive package scan, modeling of names and modules, etc |
| upload_time | 2024-09-01 14:11:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 Filip Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
thinking
import
scan
modules
meta
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# thinking-modules
[](https://github.com/FilipMalczak/thinking-modules/actions/workflows/ci.yml)
[](https://badge.fury.io/py/thinking-modules)
[](https://codecov.io/github/FilipMalczak/thinking-modules)
> Part of [thinking](https://github.com/search?q=owner%3AFilipMalczak+thinking&type=repositories) family.
Module-related python utilities - recursive package scan and import, modeling of names and modules, etc
Main use case for this library is importing everything in given package. Simplest example are
decorators that register stuff for CI, a bit like annotation scanning in Java, which need to be triggered/executed
before the main portion of your program.
Besides that provides models and related utilities for modules and their names.
> Requires python 3.12. Is properly typed.
## API
The code is pretty self-documenting (meaning "browse the code, don't expect Sphinx"). It is organized into following modules:
- [`thinking_modules.model`](./thinking_modules/model.py)
- `ModuleName`
- represent module or package name
- doesn't import the module, is just a pointer
- allows for easy modeling of subpackages, submodules, parent packages, etc
- can refer to non-existent modules
- `ModuleNamePointer`
- union type representing everything that can be parsed to `ModuleName` - a `str`, module itself, etc
- `Module`
- is a descriptor over a python module or package
- may refer to non-existing piece of code, but will raise exception when using most methods
- allows you to recognize whether something is a module, package, `pkg.__main__` file or shell session
- exposes some other useful info, like whether a module has been already imported, where is it located in filesystem
(if anywhere), what is its root package and allows you to import it with `importlib`
- most properties of `Module` and `ModuleName` are lazy and cached, so, for example, if you create a `Module` pointing
to a non-existent piece of code, it won't raise exception until you actually access `m.module_object`; similarly,
once you access `m.kind`, it will be cached and will be quickly accessible next time you access it
- kudos to [`lazy`](https://pypi.org/project/lazy/) for that
- [`thinking_modules.scan`](./thinking_modules/scan.py)
- holds a single function: `scan(pkg: ModuleNamePointer)`
- that function takes a package name (fails if given a non-package module name)
- it analyses filesystem, trying to find all the module names within the tree stemming from that package
- [`thinking_modules.main_modules`](./thinking_modules/main_module.py)
- when we're running anything, its name becomes `__main__`
- that module still should be accessible by name based on its filepath
- for example, if you do `python -m pkg.subpkg.mod`, you'll execute file `.../pkg/subpkg/mod.py` which otherwise
would be available as `pkg.subpkg.mod`, but in such runtime will have `__name__` `__main__`
- this module will analyse (on import) file structure, and expose `main_name` (of type `ModuleName`) and `main_module`
(of type `Module`) that describe `pkg.subpkg.mod` (as opposed to `__main__`)
- it will also (on import) alias `pkg.subpkg.mod` in `sys.modules` to `__main__`, so you can safely do circular imports
- [`thinking_modules.definitions`](./thinking_modules/definitions.py)
- micro-DSL for queries like:
- `instance(SomeClass()).type_.defining_module`
- `type_(SomeClass).defining_module` (equivalent to the one above)
- `instance(...).type_.defined_in_module("pkg.mod")`
- `instance(...).type_.defined_in_package("pkg")` (meaning "in package `pkg` or any of its subpackages or submodules)
- nothing complicated, but makes for readable metaprogramming code
- [`thinking_modules.immutable`](./thinking_modules/immutable.py)
- helper module for something that emulates `NamedTuple`, while allowing for `lazy` properties
- not really related to domain of this project, strictly technical, but pretty useful util
- is needed, as `lazy` works around the `__dict__`, which is lacking in `NamedTuple`s
Reading [the test suite](./test) is gonna be useful too, in case of uncertainty.
Raw data
{
"_id": null,
"home_page": null,
"name": "thinking-modules",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "thinking, import, scan, modules, meta",
"author": null,
"author_email": "Filip Malczak <filip.malczak@gmail.com>",
"download_url": null,
"platform": null,
"description": "# thinking-modules\n\n[](https://github.com/FilipMalczak/thinking-modules/actions/workflows/ci.yml)\n[](https://badge.fury.io/py/thinking-modules)\n[](https://codecov.io/github/FilipMalczak/thinking-modules)\n\n\n> Part of [thinking](https://github.com/search?q=owner%3AFilipMalczak+thinking&type=repositories) family.\n\nModule-related python utilities - recursive package scan and import, modeling of names and modules, etc\n\nMain use case for this library is importing everything in given package. Simplest example are\ndecorators that register stuff for CI, a bit like annotation scanning in Java, which need to be triggered/executed\nbefore the main portion of your program.\n\nBesides that provides models and related utilities for modules and their names.\n\n> Requires python 3.12. Is properly typed. \n\n## API\n\nThe code is pretty self-documenting (meaning \"browse the code, don't expect Sphinx\"). It is organized into following modules:\n- [`thinking_modules.model`](./thinking_modules/model.py)\n - `ModuleName`\n - represent module or package name\n - doesn't import the module, is just a pointer\n - allows for easy modeling of subpackages, submodules, parent packages, etc\n - can refer to non-existent modules\n - `ModuleNamePointer`\n - union type representing everything that can be parsed to `ModuleName` - a `str`, module itself, etc\n - `Module`\n - is a descriptor over a python module or package\n - may refer to non-existing piece of code, but will raise exception when using most methods\n - allows you to recognize whether something is a module, package, `pkg.__main__` file or shell session\n - exposes some other useful info, like whether a module has been already imported, where is it located in filesystem\n (if anywhere), what is its root package and allows you to import it with `importlib`\n - most properties of `Module` and `ModuleName` are lazy and cached, so, for example, if you create a `Module` pointing\n to a non-existent piece of code, it won't raise exception until you actually access `m.module_object`; similarly,\n once you access `m.kind`, it will be cached and will be quickly accessible next time you access it\n - kudos to [`lazy`](https://pypi.org/project/lazy/) for that\n- [`thinking_modules.scan`](./thinking_modules/scan.py)\n - holds a single function: `scan(pkg: ModuleNamePointer)`\n - that function takes a package name (fails if given a non-package module name)\n - it analyses filesystem, trying to find all the module names within the tree stemming from that package\n- [`thinking_modules.main_modules`](./thinking_modules/main_module.py)\n - when we're running anything, its name becomes `__main__`\n - that module still should be accessible by name based on its filepath\n - for example, if you do `python -m pkg.subpkg.mod`, you'll execute file `.../pkg/subpkg/mod.py` which otherwise\n would be available as `pkg.subpkg.mod`, but in such runtime will have `__name__` `__main__`\n - this module will analyse (on import) file structure, and expose `main_name` (of type `ModuleName`) and `main_module`\n (of type `Module`) that describe `pkg.subpkg.mod` (as opposed to `__main__`)\n - it will also (on import) alias `pkg.subpkg.mod` in `sys.modules` to `__main__`, so you can safely do circular imports\n- [`thinking_modules.definitions`](./thinking_modules/definitions.py)\n - micro-DSL for queries like:\n - `instance(SomeClass()).type_.defining_module`\n - `type_(SomeClass).defining_module` (equivalent to the one above)\n - `instance(...).type_.defined_in_module(\"pkg.mod\")`\n - `instance(...).type_.defined_in_package(\"pkg\")` (meaning \"in package `pkg` or any of its subpackages or submodules)\n - nothing complicated, but makes for readable metaprogramming code\n- [`thinking_modules.immutable`](./thinking_modules/immutable.py)\n - helper module for something that emulates `NamedTuple`, while allowing for `lazy` properties\n - not really related to domain of this project, strictly technical, but pretty useful util\n - is needed, as `lazy` works around the `__dict__`, which is lacking in `NamedTuple`s\n\nReading [the test suite](./test) is gonna be useful too, in case of uncertainty.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Filip Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Module-related python utilities - recursive package scan, modeling of names and modules, etc",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/FilipMalczak/thinking-modules"
},
"split_keywords": [
"thinking",
" import",
" scan",
" modules",
" meta"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bde9f12cf811dbf601604834145f0a2c42b491919f4b7056e5417c25188c50da",
"md5": "e99a7aaea5d79aa9f474391cba290c08",
"sha256": "91f55dd9c5fc206ebd101a9cdd9529c560973a48131b68d07944b54fa8e3198e"
},
"downloads": -1,
"filename": "thinking_modules-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e99a7aaea5d79aa9f474391cba290c08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 9084,
"upload_time": "2024-09-01T14:11:33",
"upload_time_iso_8601": "2024-09-01T14:11:33.025908Z",
"url": "https://files.pythonhosted.org/packages/bd/e9/f12cf811dbf601604834145f0a2c42b491919f4b7056e5417c25188c50da/thinking_modules-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 14:11:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FilipMalczak",
"github_project": "thinking-modules",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "thinking-modules"
}
