Compare commits

..

11 commits

Author SHA1 Message Date
Dima Gerasimov
bb703c8c6a twitter.android: fix get_own_user_id for latest exports 2024-12-29 15:48:15 +00:00
Dima Gerasimov
54df429f61 core.sqlite: add helper SqliteTool to get table schemas 2024-12-29 15:16:03 +00:00
purarue
f1d23c5e96 smscalls: allow large XML files as input
once XML files increase past a certain size
(was about 220MB for me), the parser just throws
an error because the tree is too large (iirc for
security reasons)

could maybe look at using iterparse in the future
to parse it without loading the whole file, but this
seems to fix it fine for me
2024-12-28 21:46:28 +00:00
purarue
d8c53bde34 smscalls: add phone number to model 2024-11-26 21:53:52 +00:00
purarue
95a16b956f
doc: some performance notes for query_range (#409)
* doc: some performance notes for query_range
* add ruff_cache to gitignore
2024-11-26 21:53:10 +00:00
purarue
a7f05c2cad doc: spelling fixes 2024-11-26 21:51:40 +00:00
Srajan Garg
ad55c5c345
fix typo in rexport DAL (#405)
* fix typo in rexport DAL
2024-11-13 00:05:27 +00:00
purarue
7ab6f0d5cb chore: update urls 2024-10-30 20:12:00 +00:00
Dima Gerasimov
a2b397ec4a my.whatsapp.android: adapt to new db format 2024-10-22 21:35:52 +01:00
Dima Gerasimov
8496d131e7 general: migrate modules to use 3.9 features 2024-10-19 23:41:22 +01:00
karlicoss
d3f9a8e8b6
core: migrate code to benefit from 3.9 stuff (#401)
for now keeping ruff on 3.8 target version, need to sort out modules as well
2024-10-19 20:55:09 +01:00
178 changed files with 1593 additions and 1244 deletions

3
.gitignore vendored
View file

@ -155,6 +155,9 @@ celerybeat-schedule
.dmypy.json .dmypy.json
dmypy.json dmypy.json
# linters
.ruff_cache/
# Pyre type checker # Pyre type checker
.pyre/ .pyre/

View file

@ -20,7 +20,7 @@ General/my.core changes:
- e81dddddf083ffd81aa7e2b715bd34f59949479c properly resolve class properties in make_config + add test - e81dddddf083ffd81aa7e2b715bd34f59949479c properly resolve class properties in make_config + add test
Modules: Modules:
- some innitial work on filling **InfluxDB** with HPI data - some initial work on filling **InfluxDB** with HPI data
- pinboard - pinboard
- 42399f6250d9901d93dcedcfe05f7857babcf834: **breaking backwards compatibility**, use pinbexport module directly - 42399f6250d9901d93dcedcfe05f7857babcf834: **breaking backwards compatibility**, use pinbexport module directly

View file

@ -723,10 +723,10 @@ If you want to write modules for personal use but don't want to merge them into
Other HPI Repositories: Other HPI Repositories:
- [[https://github.com/seanbreckenridge/HPI][seanbreckenridge/HPI]] - [[https://github.com/purarue/HPI][purarue/HPI]]
- [[https://github.com/madelinecameron/hpi][madelinecameron/HPI]] - [[https://github.com/madelinecameron/hpi][madelinecameron/HPI]]
If you want to create your own to create your own modules/override something here, you can use the [[https://github.com/seanbreckenridge/HPI-template][template]]. If you want to create your own to create your own modules/override something here, you can use the [[https://github.com/purarue/HPI-template][template]].
* Related links * Related links
:PROPERTIES: :PROPERTIES:

View file

@ -76,7 +76,7 @@ This would typically be used in an overridden `all.py` file, or in a one-off scr
which you may want to filter out some items from a source, progressively adding more which you may want to filter out some items from a source, progressively adding more
items to the denylist as you go. items to the denylist as you go.
A potential `my/ip/all.py` file might look like (Sidenote: `discord` module from [here](https://github.com/seanbreckenridge/HPI)): A potential `my/ip/all.py` file might look like (Sidenote: `discord` module from [here](https://github.com/purarue/HPI)):
```python ```python
from typing import Iterator from typing import Iterator
@ -119,9 +119,9 @@ python3 -c 'from my.ip import all; all.deny.deny_cli(all.ips())'
To edit the `all.py`, you could either: To edit the `all.py`, you could either:
- install it as editable (`python3 -m pip install --user -e ./HPI`), and then edit the file directly - install it as editable (`python3 -m pip install --user -e ./HPI`), and then edit the file directly
- or, create a namespace package, which splits the package across multiple directories. For info on that see [`MODULE_DESIGN`](https://github.com/karlicoss/HPI/blob/master/doc/MODULE_DESIGN.org#namespace-packages), [`reorder_editable`](https://github.com/seanbreckenridge/reorder_editable), and possibly the [`HPI-template`](https://github.com/seanbreckenridge/HPI-template) to create your own HPI namespace package to create your own `all.py` file. - or, create a namespace package, which splits the package across multiple directories. For info on that see [`MODULE_DESIGN`](https://github.com/karlicoss/HPI/blob/master/doc/MODULE_DESIGN.org#namespace-packages), [`reorder_editable`](https://github.com/purarue/reorder_editable), and possibly the [`HPI-template`](https://github.com/purarue/HPI-template) to create your own HPI namespace package to create your own `all.py` file.
For a real example of this see, [seanbreckenridge/HPI-personal](https://github.com/seanbreckenridge/HPI-personal/blob/master/my/ip/all.py) For a real example of this see, [purarue/HPI-personal](https://github.com/purarue/HPI-personal/blob/master/my/ip/all.py)
Sidenote: the reason why we want to specifically override Sidenote: the reason why we want to specifically override
the all.py and not just create a script that filters out the items you're the all.py and not just create a script that filters out the items you're

View file

@ -76,7 +76,7 @@ The config snippets below are meant to be modified accordingly and *pasted into
You don't have to set up all modules at once, it's recommended to do it gradually, to get the feel of how HPI works. You don't have to set up all modules at once, it's recommended to do it gradually, to get the feel of how HPI works.
For an extensive/complex example, you can check out ~@seanbreckenridge~'s [[https://github.com/seanbreckenridge/dotfiles/blob/master/.config/my/my/config/__init__.py][config]] For an extensive/complex example, you can check out ~@purarue~'s [[https://github.com/purarue/dotfiles/blob/master/.config/my/my/config/__init__.py][config]]
# Nested Configurations before the doc generation using the block below # Nested Configurations before the doc generation using the block below
** [[file:../my/reddit][my.reddit]] ** [[file:../my/reddit][my.reddit]]
@ -96,7 +96,7 @@ For an extensive/complex example, you can check out ~@seanbreckenridge~'s [[http
class pushshift: class pushshift:
''' '''
Uses [[https://github.com/seanbreckenridge/pushshift_comment_export][pushshift]] to get access to old comments Uses [[https://github.com/purarue/pushshift_comment_export][pushshift]] to get access to old comments
''' '''
# path[s]/glob to the exported JSON data # path[s]/glob to the exported JSON data
@ -106,7 +106,7 @@ For an extensive/complex example, you can check out ~@seanbreckenridge~'s [[http
** [[file:../my/browser/][my.browser]] ** [[file:../my/browser/][my.browser]]
Parses browser history using [[http://github.com/seanbreckenridge/browserexport][browserexport]] Parses browser history using [[http://github.com/purarue/browserexport][browserexport]]
#+begin_src python #+begin_src python
class browser: class browser:
@ -132,7 +132,7 @@ For an extensive/complex example, you can check out ~@seanbreckenridge~'s [[http
You might also be able to use [[file:../my/location/via_ip.py][my.location.via_ip]] which uses =my.ip.all= to You might also be able to use [[file:../my/location/via_ip.py][my.location.via_ip]] which uses =my.ip.all= to
provide geolocation data for an IPs (though no IPs are provided from any provide geolocation data for an IPs (though no IPs are provided from any
of the sources here). For an example of usage, see [[https://github.com/seanbreckenridge/HPI/tree/master/my/ip][here]] of the sources here). For an example of usage, see [[https://github.com/purarue/HPI/tree/master/my/ip][here]]
#+begin_src python #+begin_src python
class location: class location:
@ -256,9 +256,9 @@ for cls, p in modules:
** [[file:../my/google/takeout/parser.py][my.google.takeout.parser]] ** [[file:../my/google/takeout/parser.py][my.google.takeout.parser]]
Parses Google Takeout using [[https://github.com/seanbreckenridge/google_takeout_parser][google_takeout_parser]] Parses Google Takeout using [[https://github.com/purarue/google_takeout_parser][google_takeout_parser]]
See [[https://github.com/seanbreckenridge/google_takeout_parser][google_takeout_parser]] for more information about how to export and organize your takeouts See [[https://github.com/purarue/google_takeout_parser][google_takeout_parser]] for more information about how to export and organize your takeouts
If the =DISABLE_TAKEOUT_CACHE= environment variable is set, this won't If the =DISABLE_TAKEOUT_CACHE= environment variable is set, this won't
cache individual exports in =~/.cache/google_takeout_parser= cache individual exports in =~/.cache/google_takeout_parser=

View file

@ -67,7 +67,7 @@ If you want to disable a source, you have a few options.
... that suppresses the warning message and lets you use ~my.location.all~ without having to change any lines of code ... that suppresses the warning message and lets you use ~my.location.all~ without having to change any lines of code
Another benefit is that all the custom sources/data is localized to the ~all.py~ file, so a user can override the ~all.py~ (see the sections below on ~namespace packages~) file in their own HPI repository, adding additional sources without having to maintain a fork and patching in changes as things eventually change. For a 'real world' example of that, see [[https://github.com/seanbreckenridge/HPI#partially-in-usewith-overrides][seanbreckenridge]]s location and ip modules. Another benefit is that all the custom sources/data is localized to the ~all.py~ file, so a user can override the ~all.py~ (see the sections below on ~namespace packages~) file in their own HPI repository, adding additional sources without having to maintain a fork and patching in changes as things eventually change. For a 'real world' example of that, see [[https://github.com/purarue/HPI#partially-in-usewith-overrides][purarue]]s location and ip modules.
This is of course not required for personal or single file modules, its just the pattern that seems to have the least amount of friction for the user, while being extendable, and without using a bulky plugin system to let users add additional sources. This is of course not required for personal or single file modules, its just the pattern that seems to have the least amount of friction for the user, while being extendable, and without using a bulky plugin system to let users add additional sources.
@ -208,13 +208,13 @@ Where ~lastfm.py~ is your version of ~my.lastfm~, which you've copied from this
Then, running ~python3 -m pip install -e .~ in that directory would install that as part of the namespace package, and assuming (see below for possible issues) this appears on ~sys.path~ before the upstream repository, your ~lastfm.py~ file overrides the upstream. Adding more files, like ~my.some_new_module~ into that directory immediately updates the global ~my~ package -- allowing you to quickly add new modules without having to re-install. Then, running ~python3 -m pip install -e .~ in that directory would install that as part of the namespace package, and assuming (see below for possible issues) this appears on ~sys.path~ before the upstream repository, your ~lastfm.py~ file overrides the upstream. Adding more files, like ~my.some_new_module~ into that directory immediately updates the global ~my~ package -- allowing you to quickly add new modules without having to re-install.
If you install both directories as editable packages (which has the benefit of any changes you making in either repository immediately updating the globally installed ~my~ package), there are some concerns with which editable install appears on your ~sys.path~ first. If you wanted your modules to override the upstream modules, yours would have to appear on the ~sys.path~ first (this is the same reason that =custom_lastfm_overlay= must be at the front of your ~PYTHONPATH~). For more details and examples on dealing with editable namespace packages in the context of HPI, see the [[https://github.com/seanbreckenridge/reorder_editable][reorder_editable]] repository. If you install both directories as editable packages (which has the benefit of any changes you making in either repository immediately updating the globally installed ~my~ package), there are some concerns with which editable install appears on your ~sys.path~ first. If you wanted your modules to override the upstream modules, yours would have to appear on the ~sys.path~ first (this is the same reason that =custom_lastfm_overlay= must be at the front of your ~PYTHONPATH~). For more details and examples on dealing with editable namespace packages in the context of HPI, see the [[https://github.com/purarue/reorder_editable][reorder_editable]] repository.
There is no limit to how many directories you could install into a single namespace package, which could be a possible way for people to install additional HPI modules, without worrying about the module count here becoming too large to manage. There is no limit to how many directories you could install into a single namespace package, which could be a possible way for people to install additional HPI modules, without worrying about the module count here becoming too large to manage.
There are some other users [[https://github.com/hpi/hpi][who have begun publishing their own modules]] as namespace packages, which you could potentially install and use, in addition to this repository, if any of those interest you. If you want to create your own you can use the [[https://github.com/seanbreckenridge/HPI-template][template]] to get started. There are some other users [[https://github.com/hpi/hpi][who have begun publishing their own modules]] as namespace packages, which you could potentially install and use, in addition to this repository, if any of those interest you. If you want to create your own you can use the [[https://github.com/purarue/HPI-template][template]] to get started.
Though, enabling this many modules may make ~hpi doctor~ look pretty busy. You can explicitly choose to enable/disable modules with a list of modules/regexes in your [[https://github.com/karlicoss/HPI/blob/f559e7cb899107538e6c6bbcf7576780604697ef/my/core/core_config.py#L24-L55][core config]], see [[https://github.com/seanbreckenridge/dotfiles/blob/a1a77c581de31bd55a6af3d11b8af588614a207e/.config/my/my/config/__init__.py#L42-L72][here]] for an example. Though, enabling this many modules may make ~hpi doctor~ look pretty busy. You can explicitly choose to enable/disable modules with a list of modules/regexes in your [[https://github.com/karlicoss/HPI/blob/f559e7cb899107538e6c6bbcf7576780604697ef/my/core/core_config.py#L24-L55][core config]], see [[https://github.com/purarue/dotfiles/blob/a1a77c581de31bd55a6af3d11b8af588614a207e/.config/my/my/config/__init__.py#L42-L72][here]] for an example.
You may use the other modules or [[https://github.com/karlicoss/hpi-personal-overlay][my overlay]] as reference, but python packaging is already a complicated issue, before adding complexities like namespace packages and editable installs on top of it... If you're having trouble extending HPI in this fashion, you can open an issue here, preferably with a link to your code/repository and/or ~setup.py~ you're trying to use. You may use the other modules or [[https://github.com/karlicoss/hpi-personal-overlay][my overlay]] as reference, but python packaging is already a complicated issue, before adding complexities like namespace packages and editable installs on top of it... If you're having trouble extending HPI in this fashion, you can open an issue here, preferably with a link to your code/repository and/or ~setup.py~ you're trying to use.

View file

@ -10,7 +10,7 @@ Relevant discussion about overlays: https://github.com/karlicoss/HPI/issues/102
# You can see them TODO in overlays dir # You can see them TODO in overlays dir
Consider a toy package/module structure with minimal code, wihout any actual data parsing, just for demonstration purposes. Consider a toy package/module structure with minimal code, without any actual data parsing, just for demonstration purposes.
- =main= package structure - =main= package structure
# TODO do links # TODO do links
@ -19,7 +19,7 @@ Consider a toy package/module structure with minimal code, wihout any actual dat
Extracts Twitter data from GDPR archive. Extracts Twitter data from GDPR archive.
- =my/twitter/all.py= - =my/twitter/all.py=
Merges twitter data from multiple sources (only =gdpr= in this case), so data consumers are agnostic of specific data sources used. Merges twitter data from multiple sources (only =gdpr= in this case), so data consumers are agnostic of specific data sources used.
This will be overriden by =overlay=. This will be overridden by =overlay=.
- =my/twitter/common.py= - =my/twitter/common.py=
Contains helper function to merge data, so they can be reused by overlay's =all.py=. Contains helper function to merge data, so they can be reused by overlay's =all.py=.
- =my/reddit.py= - =my/reddit.py=
@ -66,7 +66,7 @@ This basically means that modules will be searched in both paths, with overlay t
** Installing with =--use-pep517= ** Installing with =--use-pep517=
See here for discussion https://github.com/seanbreckenridge/reorder_editable/issues/2, but TLDR it should work similarly. See here for discussion https://github.com/purarue/reorder_editable/issues/2, but TLDR it should work similarly.
* Testing runtime behaviour (editable install) * Testing runtime behaviour (editable install)
@ -126,7 +126,7 @@ https://github.com/python/mypy/blob/1dd8e7fe654991b01bd80ef7f1f675d9e3910c3a/myp
For now, I opened an issue in mypy repository https://github.com/python/mypy/issues/16683 For now, I opened an issue in mypy repository https://github.com/python/mypy/issues/16683
But ok, maybe mypy treats =main= as an external package somhow but still type checks it properly? But ok, maybe mypy treats =main= as an external package somehow but still type checks it properly?
Let's see what's going on with imports: Let's see what's going on with imports:
: $ mypy --namespace-packages --strict -p my --follow-imports=error : $ mypy --namespace-packages --strict -p my --follow-imports=error

View file

@ -97,9 +97,9 @@ By default, this just returns the items in the order they were returned by the f
hpi query my.coding.commits.commits --order-key committed_dt --limit 1 --reverse --output pprint --stream hpi query my.coding.commits.commits --order-key committed_dt --limit 1 --reverse --output pprint --stream
Commit(committed_dt=datetime.datetime(2023, 4, 14, 23, 9, 1, tzinfo=datetime.timezone(datetime.timedelta(days=-1, seconds=61200))), Commit(committed_dt=datetime.datetime(2023, 4, 14, 23, 9, 1, tzinfo=datetime.timezone(datetime.timedelta(days=-1, seconds=61200))),
authored_dt=datetime.datetime(2023, 4, 14, 23, 4, 1, tzinfo=datetime.timezone(datetime.timedelta(days=-1, seconds=61200))), authored_dt=datetime.datetime(2023, 4, 14, 23, 4, 1, tzinfo=datetime.timezone(datetime.timedelta(days=-1, seconds=61200))),
message='sources.smscalls: propogate errors if there are breaking ' message='sources.smscalls: propagate errors if there are breaking '
'schema changes', 'schema changes',
repo='/home/sean/Repos/promnesia-fork', repo='/home/username/Repos/promnesia-fork',
sha='22a434fca9a28df9b0915ccf16368df129d2c9ce', sha='22a434fca9a28df9b0915ccf16368df129d2c9ce',
ref='refs/heads/smscalls-handle-result') ref='refs/heads/smscalls-handle-result')
``` ```
@ -195,7 +195,7 @@ To preview, you can use something like [`qgis`](https://qgis.org/en/site/) or fo
<img src="https://user-images.githubusercontent.com/7804791/232249184-7e203ee6-a3ec-4053-800c-751d2c28e690.png" width=500 alt="chicago trip" /> <img src="https://user-images.githubusercontent.com/7804791/232249184-7e203ee6-a3ec-4053-800c-751d2c28e690.png" width=500 alt="chicago trip" />
(Sidenote: this is [`@seanbreckenridge`](https://github.com/seanbreckenridge/)s locations, on a trip to Chicago) (Sidenote: this is [`@purarue`](https://github.com/purarue/)s locations, on a trip to Chicago)
## Python reference ## Python reference
@ -301,4 +301,4 @@ The `hpi query` command is a CLI wrapper around the code in [`query.py`](../my/c
If you specify a range, drop_unsorted is forced to be True If you specify a range, drop_unsorted is forced to be True
``` ```
Those can be imported and accept any sort of iterator, `hpi query` just defaults to the output of functions here. As an example, see [`listens`](https://github.com/seanbreckenridge/HPI-personal/blob/master/scripts/listens) which just passes an generator (iterator) as the first argument to `query_range` Those can be imported and accept any sort of iterator, `hpi query` just defaults to the output of functions here. As an example, see [`listens`](https://github.com/purarue/HPI-personal/blob/master/scripts/listens) which just passes an generator (iterator) as the first argument to `query_range`

View file

@ -387,7 +387,7 @@ But there is an extra caveat: rexport is already coming with nice [[https://gith
Several other HPI modules are following a similar pattern: hypothesis, instapaper, pinboard, kobo, etc. Several other HPI modules are following a similar pattern: hypothesis, instapaper, pinboard, kobo, etc.
Since the [[https://github.com/karlicoss/rexport#api-limitations][reddit API has limited results]], you can use [[https://github.com/seanbreckenridge/pushshift_comment_export][my.reddit.pushshift]] to access older reddit comments, which both then get merged into =my.reddit.all.comments= Since the [[https://github.com/karlicoss/rexport#api-limitations][reddit API has limited results]], you can use [[https://github.com/purarue/pushshift_comment_export][my.reddit.pushshift]] to access older reddit comments, which both then get merged into =my.reddit.all.comments=
** Twitter ** Twitter

View file

@ -32,6 +32,6 @@ ignore =
# #
# as a reference: # as a reference:
# https://github.com/seanbreckenridge/cookiecutter-template/blob/master/%7B%7Bcookiecutter.module_name%7D%7D/setup.cfg # https://github.com/purarue/cookiecutter-template/blob/master/%7B%7Bcookiecutter.module_name%7D%7D/setup.cfg
# and this https://github.com/karlicoss/HPI/pull/151 # and this https://github.com/karlicoss/HPI/pull/151
# find ./my | entr flake8 --ignore=E402,E501,E741,W503,E266,E302,E305,E203,E261,E252,E251,E221,W291,E225,E303,E702,E202,F841,E731,E306,E127 E722,E231 my | grep -v __NOT_HPI_MODULE__ # find ./my | entr flake8 --ignore=E402,E501,E741,W503,E266,E302,E305,E203,E261,E252,E251,E221,W291,E225,E303,E702,E202,F841,E731,E306,E127 E722,E231 my | grep -v __NOT_HPI_MODULE__

View file

@ -2,20 +2,22 @@
[[https://github.com/nomeata/arbtt#arbtt-the-automatic-rule-based-time-tracker][Arbtt]] time tracking [[https://github.com/nomeata/arbtt#arbtt-the-automatic-rule-based-time-tracker][Arbtt]] time tracking
''' '''
from __future__ import annotations
REQUIRES = ['ijson', 'cffi'] REQUIRES = ['ijson', 'cffi']
# NOTE likely also needs libyajl2 from apt or elsewhere? # NOTE likely also needs libyajl2 from apt or elsewhere?
from collections.abc import Iterable, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from pathlib import Path from pathlib import Path
from typing import Sequence, Iterable, List, Optional
def inputs() -> Sequence[Path]: def inputs() -> Sequence[Path]:
try: try:
from my.config import arbtt as user_config from my.config import arbtt as user_config
except ImportError: except ImportError:
from .core.warnings import low from my.core.warnings import low
low("Couldn't find 'arbtt' config section, falling back to the default capture.log (usually in HOME dir). Add 'arbtt' section with logfiles = '' to suppress this warning.") low("Couldn't find 'arbtt' config section, falling back to the default capture.log (usually in HOME dir). Add 'arbtt' section with logfiles = '' to suppress this warning.")
return [] return []
else: else:
@ -55,7 +57,7 @@ class Entry:
return fromisoformat(ds) return fromisoformat(ds)
@property @property
def active(self) -> Optional[str]: def active(self) -> str | None:
# NOTE: WIP, might change this in the future... # NOTE: WIP, might change this in the future...
ait = (w for w in self.json['windows'] if w['active']) ait = (w for w in self.json['windows'] if w['active'])
a = next(ait, None) a = next(ait, None)
@ -74,17 +76,18 @@ class Entry:
def entries() -> Iterable[Entry]: def entries() -> Iterable[Entry]:
inps = list(inputs()) inps = list(inputs())
base: List[PathIsh] = ['arbtt-dump', '--format=json'] base: list[PathIsh] = ['arbtt-dump', '--format=json']
cmds: List[List[PathIsh]] cmds: list[list[PathIsh]]
if len(inps) == 0: if len(inps) == 0:
cmds = [base] # rely on default cmds = [base] # rely on default
else: else:
# otherwise, 'merge' them # otherwise, 'merge' them
cmds = [[*base, '--logfile', f] for f in inps] cmds = [[*base, '--logfile', f] for f in inps]
import ijson.backends.yajl2_cffi as ijson # type: ignore from subprocess import PIPE, Popen
from subprocess import Popen, PIPE
import ijson.backends.yajl2_cffi as ijson # type: ignore
for cmd in cmds: for cmd in cmds:
with Popen(cmd, stdout=PIPE) as p: with Popen(cmd, stdout=PIPE) as p:
out = p.stdout; assert out is not None out = p.stdout; assert out is not None
@ -93,8 +96,8 @@ def entries() -> Iterable[Entry]:
def fill_influxdb() -> None: def fill_influxdb() -> None:
from .core.influxdb import magic_fill
from .core.freezer import Freezer from .core.freezer import Freezer
from .core.influxdb import magic_fill
freezer = Freezer(Entry) freezer = Freezer(Entry)
fit = (freezer.freeze(e) for e in entries()) fit = (freezer.freeze(e) for e in entries())
# TODO crap, influxdb doesn't like None https://github.com/influxdata/influxdb/issues/7722 # TODO crap, influxdb doesn't like None https://github.com/influxdata/influxdb/issues/7722
@ -106,6 +109,8 @@ def fill_influxdb() -> None:
magic_fill(fit, name=f'{entries.__module__}:{entries.__name__}') magic_fill(fit, name=f'{entries.__module__}:{entries.__name__}')
from .core import stat, Stats from .core import Stats, stat
def stats() -> Stats: def stats() -> Stats:
return stat(entries) return stat(entries)

View file

@ -2,14 +2,17 @@
[[https://bluemaestro.com/products/product-details/bluetooth-environmental-monitor-and-logger][Bluemaestro]] temperature/humidity/pressure monitor [[https://bluemaestro.com/products/product-details/bluetooth-environmental-monitor-and-logger][Bluemaestro]] temperature/humidity/pressure monitor
""" """
from __future__ import annotations
# todo most of it belongs to DAL... but considering so few people use it I didn't bother for now # todo most of it belongs to DAL... but considering so few people use it I didn't bother for now
import re import re
import sqlite3 import sqlite3
from abc import abstractmethod from abc import abstractmethod
from collections.abc import Iterable, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timedelta from datetime import datetime, timedelta
from pathlib import Path from pathlib import Path
from typing import Iterable, Optional, Protocol, Sequence, Set from typing import Protocol
import pytz import pytz
@ -87,17 +90,17 @@ def measurements() -> Iterable[Res[Measurement]]:
total = len(paths) total = len(paths)
width = len(str(total)) width = len(str(total))
last: Optional[datetime] = None last: datetime | None = None
# tables are immutable, so can save on processing.. # tables are immutable, so can save on processing..
processed_tables: Set[str] = set() processed_tables: set[str] = set()
for idx, path in enumerate(paths): for idx, path in enumerate(paths):
logger.info(f'processing [{idx:>{width}}/{total:>{width}}] {path}') logger.info(f'processing [{idx:>{width}}/{total:>{width}}] {path}')
tot = 0 tot = 0
new = 0 new = 0
# todo assert increasing timestamp? # todo assert increasing timestamp?
with sqlite_connect_immutable(path) as db: with sqlite_connect_immutable(path) as db:
db_dt: Optional[datetime] = None db_dt: datetime | None = None
try: try:
datas = db.execute( datas = db.execute(
f'SELECT "{path.name}" as name, Time, Temperature, Humidity, Pressure, Dewpoint FROM data ORDER BY log_index' f'SELECT "{path.name}" as name, Time, Temperature, Humidity, Pressure, Dewpoint FROM data ORDER BY log_index'

View file

@ -2,41 +2,42 @@
Blood tracking (manual org-mode entries) Blood tracking (manual org-mode entries)
""" """
from __future__ import annotations
from collections.abc import Iterable
from datetime import datetime from datetime import datetime
from typing import Iterable, NamedTuple, Optional from typing import NamedTuple
from ..core.error import Res
from ..core.orgmode import parse_org_datetime, one_table
import pandas as pd
import orgparse import orgparse
import pandas as pd
from my.config import blood as config # type: ignore[attr-defined] from my.config import blood as config # type: ignore[attr-defined]
from ..core.error import Res
from ..core.orgmode import one_table, parse_org_datetime
class Entry(NamedTuple): class Entry(NamedTuple):
dt: datetime dt: datetime
ketones : Optional[float]=None ketones : float | None=None
glucose : Optional[float]=None glucose : float | None=None
vitamin_d : Optional[float]=None vitamin_d : float | None=None
vitamin_b12 : Optional[float]=None vitamin_b12 : float | None=None
hdl : Optional[float]=None hdl : float | None=None
ldl : Optional[float]=None ldl : float | None=None
triglycerides: Optional[float]=None triglycerides: float | None=None
source : Optional[str]=None source : str | None=None
extra : Optional[str]=None extra : str | None=None
Result = Res[Entry] Result = Res[Entry]
def try_float(s: str) -> Optional[float]: def try_float(s: str) -> float | None:
l = s.split() l = s.split()
if len(l) == 0: if len(l) == 0:
return None return None
@ -105,6 +106,7 @@ def blood_tests_data() -> Iterable[Result]:
def data() -> Iterable[Result]: def data() -> Iterable[Result]:
from itertools import chain from itertools import chain
from ..core.error import sort_res_by from ..core.error import sort_res_by
datas = chain(glucose_ketones_data(), blood_tests_data()) datas = chain(glucose_ketones_data(), blood_tests_data())
return sort_res_by(datas, key=lambda e: e.dt) return sort_res_by(datas, key=lambda e: e.dt)

View file

@ -7,10 +7,10 @@ from ...core.pandas import DataFrameT, check_dataframe
@check_dataframe @check_dataframe
def dataframe() -> DataFrameT: def dataframe() -> DataFrameT:
# this should be somehow more flexible... # this should be somehow more flexible...
from ...endomondo import dataframe as EDF
from ...runnerup import dataframe as RDF
import pandas as pd import pandas as pd
from ...endomondo import dataframe as EDF
from ...runnerup import dataframe as RDF
return pd.concat([ return pd.concat([
EDF(), EDF(),
RDF(), RDF(),

View file

@ -3,7 +3,6 @@ Cardio data, filtered from various data sources
''' '''
from ...core.pandas import DataFrameT, check_dataframe from ...core.pandas import DataFrameT, check_dataframe
CARDIO = { CARDIO = {
'Running', 'Running',
'Running, treadmill', 'Running, treadmill',

View file

@ -5,16 +5,18 @@ This is probably too specific to my needs, so later I will move it away to a per
For now it's worth keeping it here as an example and perhaps utility functions might be useful for other HPI modules. For now it's worth keeping it here as an example and perhaps utility functions might be useful for other HPI modules.
''' '''
from datetime import datetime, timedelta from __future__ import annotations
from typing import Optional
from ...core.pandas import DataFrameT, check_dataframe as cdf from datetime import datetime, timedelta
from ...core.orgmode import collect, Table, parse_org_datetime, TypedTable
import pytz
from my.config import exercise as config from my.config import exercise as config
from ...core.orgmode import Table, TypedTable, collect, parse_org_datetime
from ...core.pandas import DataFrameT
from ...core.pandas import check_dataframe as cdf
import pytz
# FIXME how to attach it properly? # FIXME how to attach it properly?
tz = pytz.timezone('Europe/London') tz = pytz.timezone('Europe/London')
@ -114,7 +116,7 @@ def dataframe() -> DataFrameT:
rows.append(rd) # presumably has an error set rows.append(rd) # presumably has an error set
continue continue
idx: Optional[int] idx: int | None
close = edf[edf['start_time'].apply(lambda t: pd_date_diff(t, mdate)).abs() < _DELTA] close = edf[edf['start_time'].apply(lambda t: pd_date_diff(t, mdate)).abs() < _DELTA]
if len(close) == 0: if len(close) == 0:
idx = None idx = None
@ -163,7 +165,9 @@ def dataframe() -> DataFrameT:
# TODO wtf?? where is speed coming from?? # TODO wtf?? where is speed coming from??
from ...core import stat, Stats from ...core import Stats, stat
def stats() -> Stats: def stats() -> Stats:
return stat(cross_trainer_data) return stat(cross_trainer_data)

View file

@ -1,5 +1,6 @@
from ...core import stat, Stats from ...core import Stats, stat
from ...core.pandas import DataFrameT, check_dataframe as cdf from ...core.pandas import DataFrameT
from ...core.pandas import check_dataframe as cdf
class Combine: class Combine:

View file

@ -1,7 +1,6 @@
from ... import jawbone from ... import emfit, jawbone
from ... import emfit
from .common import Combine from .common import Combine
_combined = Combine([ _combined = Combine([
jawbone, jawbone,
emfit, emfit,

View file

@ -2,14 +2,14 @@
Weight data (manually logged) Weight data (manually logged)
''' '''
from collections.abc import Iterator
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime from datetime import datetime
from typing import Any, Iterator from typing import Any
from my.core import make_logger
from my.core.error import Res, extract_error_datetime, set_error_datetime
from my import orgmode from my import orgmode
from my.core import make_logger
from my.core.error import Res, extract_error_datetime, set_error_datetime
config = Any config = Any

View file

@ -1,7 +1,6 @@
from ..core import warnings from my.core import warnings
warnings.high('my.books.kobo is deprecated! Please use my.kobo instead!') warnings.high('my.books.kobo is deprecated! Please use my.kobo instead!')
from ..core.util import __NOT_HPI_MODULE__ from my.core.util import __NOT_HPI_MODULE__
from my.kobo import *
from ..kobo import * # type: ignore[no-redef]

View file

@ -1,5 +1,5 @@
""" """
Parses active browser history by backing it up with [[http://github.com/seanbreckenridge/sqlite_backup][sqlite_backup]] Parses active browser history by backing it up with [[http://github.com/purarue/sqlite_backup][sqlite_backup]]
""" """
REQUIRES = ["browserexport", "sqlite_backup"] REQUIRES = ["browserexport", "sqlite_backup"]
@ -19,16 +19,18 @@ class config(user_config.active_browser):
export_path: Paths export_path: Paths
from collections.abc import Iterator, Sequence
from pathlib import Path from pathlib import Path
from typing import Sequence, Iterator
from my.core import get_files, Stats, make_logger from browserexport.merge import Visit, read_visits
from browserexport.merge import read_visits, Visit
from sqlite_backup import sqlite_backup from sqlite_backup import sqlite_backup
from my.core import Stats, get_files, make_logger
logger = make_logger(__name__) logger = make_logger(__name__)
from .common import _patch_browserexport_logs from .common import _patch_browserexport_logs
_patch_browserexport_logs(logger.level) _patch_browserexport_logs(logger.level)

View file

@ -1,9 +1,9 @@
from typing import Iterator from collections.abc import Iterator
from browserexport.merge import Visit, merge_visits
from my.core import Stats from my.core import Stats
from my.core.source import import_source from my.core.source import import_source
from browserexport.merge import merge_visits, Visit
src_export = import_source(module_name="my.browser.export") src_export = import_source(module_name="my.browser.export")
src_active = import_source(module_name="my.browser.active_browser") src_active = import_source(module_name="my.browser.active_browser")

View file

@ -1,14 +1,15 @@
""" """
Parses browser history using [[http://github.com/seanbreckenridge/browserexport][browserexport]] Parses browser history using [[http://github.com/purarue/browserexport][browserexport]]
""" """
REQUIRES = ["browserexport"] REQUIRES = ["browserexport"]
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from pathlib import Path from pathlib import Path
from typing import Iterator, Sequence
import my.config from browserexport.merge import Visit, read_and_merge
from my.core import ( from my.core import (
Paths, Paths,
Stats, Stats,
@ -18,10 +19,10 @@ from my.core import (
) )
from my.core.cachew import mcachew from my.core.cachew import mcachew
from browserexport.merge import read_and_merge, Visit
from .common import _patch_browserexport_logs from .common import _patch_browserexport_logs
import my.config # isort: skip
@dataclass @dataclass
class config(my.config.browser.export): class config(my.config.browser.export):

View file

@ -3,24 +3,24 @@ Bumble data from Android app database (in =/data/data/com.bumble.app/databases/C
""" """
from __future__ import annotations from __future__ import annotations
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime from datetime import datetime
from typing import Iterator, Sequence, Optional, Dict from pathlib import Path
from more_itertools import unique_everseen from more_itertools import unique_everseen
from my.config import bumble as user_config from my.core import Paths, get_files
from my.config import bumble as user_config # isort: skip
from ..core import Paths
@dataclass @dataclass
class config(user_config.android): class config(user_config.android):
# paths[s]/glob to the exported sqlite databases # paths[s]/glob to the exported sqlite databases
export_path: Paths export_path: Paths
from ..core import get_files
from pathlib import Path
def inputs() -> Sequence[Path]: def inputs() -> Sequence[Path]:
return get_files(config.export_path) return get_files(config.export_path)
@ -43,22 +43,24 @@ class _BaseMessage:
@dataclass(unsafe_hash=True) @dataclass(unsafe_hash=True)
class _Message(_BaseMessage): class _Message(_BaseMessage):
conversation_id: str conversation_id: str
reply_to_id: Optional[str] reply_to_id: str | None
@dataclass(unsafe_hash=True) @dataclass(unsafe_hash=True)
class Message(_BaseMessage): class Message(_BaseMessage):
person: Person person: Person
reply_to: Optional[Message] reply_to: Message | None
import json import json
from typing import Union
from ..core import Res
import sqlite3 import sqlite3
from ..core.sqlite import sqlite_connect_immutable, select from typing import Union
from my.core.compat import assert_never from my.core.compat import assert_never
from ..core import Res
from ..core.sqlite import select, sqlite_connect_immutable
EntitiesRes = Res[Union[Person, _Message]] EntitiesRes = Res[Union[Person, _Message]]
def _entities() -> Iterator[EntitiesRes]: def _entities() -> Iterator[EntitiesRes]:
@ -120,8 +122,8 @@ _UNKNOWN_PERSON = "UNKNOWN_PERSON"
def messages() -> Iterator[Res[Message]]: def messages() -> Iterator[Res[Message]]:
id2person: Dict[str, Person] = {} id2person: dict[str, Person] = {}
id2msg: Dict[str, Message] = {} id2msg: dict[str, Message] = {}
for x in unique_everseen(_entities(), key=_key): for x in unique_everseen(_entities(), key=_key):
if isinstance(x, Exception): if isinstance(x, Exception):
yield x yield x

View file

@ -15,7 +15,8 @@ from my.core.time import zone_to_countrycode
@lru_cache(1) @lru_cache(1)
def _calendar(): def _calendar():
from workalendar.registry import registry # type: ignore from workalendar.registry import registry # type: ignore
# todo switch to using time.tz.main once _get_tz stabilizes? # todo switch to using time.tz.main once _get_tz stabilizes?
from ..time.tz import via_location as LTZ from ..time.tz import via_location as LTZ
# TODO would be nice to do it dynamically depending on the past timezones... # TODO would be nice to do it dynamically depending on the past timezones...

View file

@ -1,7 +1,6 @@
import my.config as config import my.config as config
from .core import __NOT_HPI_MODULE__ from .core import __NOT_HPI_MODULE__
from .core import warnings as W from .core import warnings as W
# still used in Promnesia, maybe in dashboard? # still used in Promnesia, maybe in dashboard?

View file

@ -1,13 +1,12 @@
import json
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timezone from datetime import datetime, timezone
from functools import cached_property from functools import cached_property
import json
from pathlib import Path from pathlib import Path
from typing import Dict, Iterator, Sequence
from my.core import get_files, Res, datetime_aware
from my.config import codeforces as config # type: ignore[attr-defined] from my.config import codeforces as config # type: ignore[attr-defined]
from my.core import Res, datetime_aware, get_files
def inputs() -> Sequence[Path]: def inputs() -> Sequence[Path]:
@ -39,7 +38,7 @@ class Competition:
class Parser: class Parser:
def __init__(self, *, inputs: Sequence[Path]) -> None: def __init__(self, *, inputs: Sequence[Path]) -> None:
self.inputs = inputs self.inputs = inputs
self.contests: Dict[ContestId, Contest] = {} self.contests: dict[ContestId, Contest] = {}
def _parse_allcontests(self, p: Path) -> Iterator[Contest]: def _parse_allcontests(self, p: Path) -> Iterator[Contest]:
j = json.loads(p.read_text()) j = json.loads(p.read_text())

View file

@ -1,29 +1,32 @@
""" """
Git commits data for repositories on your filesystem Git commits data for repositories on your filesystem
""" """
from __future__ import annotations
REQUIRES = [ REQUIRES = [
'gitpython', 'gitpython',
] ]
import shutil import shutil
from pathlib import Path from collections.abc import Iterator, Sequence
from datetime import datetime, timezone
from dataclasses import dataclass, field from dataclasses import dataclass, field
from typing import List, Optional, Iterator, Set, Sequence, cast from datetime import datetime, timezone
from pathlib import Path
from typing import Optional, cast
from my.core import LazyLogger, PathIsh, make_config
from my.core import PathIsh, LazyLogger, make_config
from my.core.cachew import cache_dir, mcachew from my.core.cachew import cache_dir, mcachew
from my.core.warnings import high from my.core.warnings import high
from my.config import commits as user_config # isort: skip
from my.config import commits as user_config
@dataclass @dataclass
class commits_cfg(user_config): class commits_cfg(user_config):
roots: Sequence[PathIsh] = field(default_factory=list) roots: Sequence[PathIsh] = field(default_factory=list)
emails: Optional[Sequence[str]] = None emails: Sequence[str] | None = None
names: Optional[Sequence[str]] = None names: Sequence[str] | None = None
# experiment to make it lazy? # experiment to make it lazy?
@ -40,7 +43,6 @@ def config() -> commits_cfg:
import git import git
from git.repo.fun import is_git_dir from git.repo.fun import is_git_dir
log = LazyLogger(__name__, level='info') log = LazyLogger(__name__, level='info')
@ -93,7 +95,7 @@ def _git_root(git_dir: PathIsh) -> Path:
return gd # must be bare return gd # must be bare
def _repo_commits_aux(gr: git.Repo, rev: str, emitted: Set[str]) -> Iterator[Commit]: def _repo_commits_aux(gr: git.Repo, rev: str, emitted: set[str]) -> Iterator[Commit]:
# without path might not handle pull heads properly # without path might not handle pull heads properly
for c in gr.iter_commits(rev=rev): for c in gr.iter_commits(rev=rev):
if not by_me(c): if not by_me(c):
@ -120,7 +122,7 @@ def _repo_commits_aux(gr: git.Repo, rev: str, emitted: Set[str]) -> Iterator[Com
def repo_commits(repo: PathIsh): def repo_commits(repo: PathIsh):
gr = git.Repo(str(repo)) gr = git.Repo(str(repo))
emitted: Set[str] = set() emitted: set[str] = set()
for r in gr.references: for r in gr.references:
yield from _repo_commits_aux(gr=gr, rev=r.path, emitted=emitted) yield from _repo_commits_aux(gr=gr, rev=r.path, emitted=emitted)
@ -141,14 +143,14 @@ def canonical_name(repo: Path) -> str:
def _fd_path() -> str: def _fd_path() -> str:
# todo move it to core # todo move it to core
fd_path: Optional[str] = shutil.which("fdfind") or shutil.which("fd-find") or shutil.which("fd") fd_path: str | None = shutil.which("fdfind") or shutil.which("fd-find") or shutil.which("fd")
if fd_path is None: if fd_path is None:
high("my.coding.commits requires 'fd' to be installed, See https://github.com/sharkdp/fd#installation") high("my.coding.commits requires 'fd' to be installed, See https://github.com/sharkdp/fd#installation")
assert fd_path is not None assert fd_path is not None
return fd_path return fd_path
def git_repos_in(roots: List[Path]) -> List[Path]: def git_repos_in(roots: list[Path]) -> list[Path]:
from subprocess import check_output from subprocess import check_output
outputs = check_output([ outputs = check_output([
_fd_path(), _fd_path(),
@ -172,7 +174,7 @@ def git_repos_in(roots: List[Path]) -> List[Path]:
return repos return repos
def repos() -> List[Path]: def repos() -> list[Path]:
return git_repos_in(list(map(Path, config().roots))) return git_repos_in(list(map(Path, config().roots)))
@ -190,7 +192,7 @@ def _repo_depends_on(_repo: Path) -> int:
raise RuntimeError(f"Could not find a FETCH_HEAD/HEAD file in {_repo}") raise RuntimeError(f"Could not find a FETCH_HEAD/HEAD file in {_repo}")
def _commits(_repos: List[Path]) -> Iterator[Commit]: def _commits(_repos: list[Path]) -> Iterator[Commit]:
for r in _repos: for r in _repos:
yield from _cached_commits(r) yield from _cached_commits(r)

View file

@ -1,6 +1,6 @@
from .core.warnings import high from .core.warnings import high
high("DEPRECATED! Please use my.core.common instead.") high("DEPRECATED! Please use my.core.common instead.")
from .core import __NOT_HPI_MODULE__ from .core import __NOT_HPI_MODULE__
from .core.common import * from .core.common import *

View file

@ -9,17 +9,18 @@ This file is used for:
- mypy: this file provides some type annotations - mypy: this file provides some type annotations
- for loading the actual user config - for loading the actual user config
''' '''
from __future__ import annotations
#### NOTE: you won't need this line VVVV in your personal config #### NOTE: you won't need this line VVVV in your personal config
from my.core import init # noqa: F401 from my.core import init # noqa: F401 # isort: skip
### ###
from datetime import tzinfo from datetime import tzinfo
from pathlib import Path from pathlib import Path
from typing import List
from my.core import PathIsh, Paths
from my.core import Paths, PathIsh
class hypothesis: class hypothesis:
@ -75,14 +76,16 @@ class google:
takeout_path: Paths = '' takeout_path: Paths = ''
from typing import Sequence, Union, Tuple from collections.abc import Sequence
from datetime import datetime, date, timedelta from datetime import date, datetime, timedelta
from typing import Union
DateIsh = Union[datetime, date, str] DateIsh = Union[datetime, date, str]
LatLon = Tuple[float, float] LatLon = tuple[float, float]
class location: class location:
# todo ugh, need to think about it... mypy wants the type here to be general, otherwise it can't deduce # todo ugh, need to think about it... mypy wants the type here to be general, otherwise it can't deduce
# and we can't import the types from the module itself, otherwise would be circular. common module? # and we can't import the types from the module itself, otherwise would be circular. common module?
home: Union[LatLon, Sequence[Tuple[DateIsh, LatLon]]] = (1.0, -1.0) home: LatLon | Sequence[tuple[DateIsh, LatLon]] = (1.0, -1.0)
home_accuracy = 30_000.0 home_accuracy = 30_000.0
class via_ip: class via_ip:
@ -103,6 +106,8 @@ class location:
from typing import Literal from typing import Literal
class time: class time:
class tz: class tz:
policy: Literal['keep', 'convert', 'throw'] policy: Literal['keep', 'convert', 'throw']
@ -121,10 +126,9 @@ class arbtt:
logfiles: Paths logfiles: Paths
from typing import Optional
class commits: class commits:
emails: Optional[Sequence[str]] emails: Sequence[str] | None
names: Optional[Sequence[str]] names: Sequence[str] | None
roots: Sequence[PathIsh] roots: Sequence[PathIsh]
@ -150,8 +154,8 @@ class tinder:
class instagram: class instagram:
class android: class android:
export_path: Paths export_path: Paths
username: Optional[str] username: str | None
full_name: Optional[str] full_name: str | None
class gdpr: class gdpr:
export_path: Paths export_path: Paths
@ -169,7 +173,7 @@ class materialistic:
class fbmessenger: class fbmessenger:
class fbmessengerexport: class fbmessengerexport:
export_db: PathIsh export_db: PathIsh
facebook_id: Optional[str] facebook_id: str | None
class android: class android:
export_path: Paths export_path: Paths
@ -247,7 +251,7 @@ class runnerup:
class emfit: class emfit:
export_path: Path export_path: Path
timezone: tzinfo timezone: tzinfo
excluded_sids: List[str] excluded_sids: list[str]
class foursquare: class foursquare:
@ -270,7 +274,7 @@ class roamresearch:
class whatsapp: class whatsapp:
class android: class android:
export_path: Paths export_path: Paths
my_user_id: Optional[str] my_user_id: str | None
class harmonic: class harmonic:

View file

@ -4,7 +4,7 @@ from typing import TYPE_CHECKING
from .cfg import make_config from .cfg import make_config
from .common import PathIsh, Paths, get_files from .common import PathIsh, Paths, get_files
from .compat import assert_never from .compat import assert_never
from .error import Res, unwrap, notnone from .error import Res, notnone, unwrap
from .logging import ( from .logging import (
make_logger, make_logger,
) )
@ -29,22 +29,25 @@ if not TYPE_CHECKING:
__all__ = [ __all__ = [
'get_files', 'PathIsh', 'Paths',
'Json',
'make_logger',
'LazyLogger', # legacy import
'warn_if_empty',
'stat', 'Stats',
'datetime_aware', 'datetime_naive',
'assert_never', # TODO maybe deprecate from use in my.core? will be in stdlib soon
'make_config',
'__NOT_HPI_MODULE__', '__NOT_HPI_MODULE__',
'Json',
'Res', 'unwrap', 'notnone', 'LazyLogger', # legacy import
'Path',
'dataclass', 'Path', 'PathIsh',
'Paths',
'Res',
'Stats',
'assert_never', # TODO maybe deprecate from use in my.core? will be in stdlib soon
'dataclass',
'datetime_aware',
'datetime_naive',
'get_files',
'make_config',
'make_logger',
'notnone',
'stat',
'unwrap',
'warn_if_empty',
] ]
@ -52,7 +55,7 @@ __all__ = [
# you could put _init_hook.py next to your private my/config # you could put _init_hook.py next to your private my/config
# that way you can configure logging/warnings/env variables on every HPI import # that way you can configure logging/warnings/env variables on every HPI import
try: try:
import my._init_hook # type: ignore[import-not-found] import my._init_hook # type: ignore[import-not-found] # noqa: F401
except: except:
pass pass
## ##

View file

@ -1,3 +1,5 @@
from __future__ import annotations
import functools import functools
import importlib import importlib
import inspect import inspect
@ -7,17 +9,18 @@ import shutil
import sys import sys
import tempfile import tempfile
import traceback import traceback
from collections.abc import Iterable, Sequence
from contextlib import ExitStack from contextlib import ExitStack
from itertools import chain from itertools import chain
from pathlib import Path from pathlib import Path
from subprocess import PIPE, CompletedProcess, Popen, check_call, run from subprocess import PIPE, CompletedProcess, Popen, check_call, run
from typing import Any, Callable, Iterable, List, Optional, Sequence, Type from typing import Any, Callable
import click import click
@functools.lru_cache @functools.lru_cache
def mypy_cmd() -> Optional[Sequence[str]]: def mypy_cmd() -> Sequence[str] | None:
try: try:
# preferably, use mypy from current python env # preferably, use mypy from current python env
import mypy # noqa: F401 fine not to use it import mypy # noqa: F401 fine not to use it
@ -32,7 +35,7 @@ def mypy_cmd() -> Optional[Sequence[str]]:
return None return None
def run_mypy(cfg_path: Path) -> Optional[CompletedProcess]: def run_mypy(cfg_path: Path) -> CompletedProcess | None:
# todo dunno maybe use the same mypy config in repository? # todo dunno maybe use the same mypy config in repository?
# I'd need to install mypy.ini then?? # I'd need to install mypy.ini then??
env = {**os.environ} env = {**os.environ}
@ -63,21 +66,27 @@ def eprint(x: str) -> None:
# err=True prints to stderr # err=True prints to stderr
click.echo(x, err=True) click.echo(x, err=True)
def indent(x: str) -> str: def indent(x: str) -> str:
# todo use textwrap.indent?
return ''.join(' ' + l for l in x.splitlines(keepends=True)) return ''.join(' ' + l for l in x.splitlines(keepends=True))
OK = '' OK = ''
OFF = '🔲' OFF = '🔲'
def info(x: str) -> None: def info(x: str) -> None:
eprint(OK + ' ' + x) eprint(OK + ' ' + x)
def error(x: str) -> None: def error(x: str) -> None:
eprint('' + x) eprint('' + x)
def warning(x: str) -> None: def warning(x: str) -> None:
eprint('' + x) # todo yellow? eprint('' + x) # todo yellow?
def tb(e: Exception) -> None: def tb(e: Exception) -> None:
tb = ''.join(traceback.format_exception(Exception, e, e.__traceback__)) tb = ''.join(traceback.format_exception(Exception, e, e.__traceback__))
@ -86,6 +95,7 @@ def tb(e: Exception) -> None:
def config_create() -> None: def config_create() -> None:
from .preinit import get_mycfg_dir from .preinit import get_mycfg_dir
mycfg_dir = get_mycfg_dir() mycfg_dir = get_mycfg_dir()
created = False created = False
@ -94,7 +104,8 @@ def config_create() -> None:
my_config = mycfg_dir / 'my' / 'config' / '__init__.py' my_config = mycfg_dir / 'my' / 'config' / '__init__.py'
my_config.parent.mkdir(parents=True) my_config.parent.mkdir(parents=True)
my_config.write_text(''' my_config.write_text(
'''
### HPI personal config ### HPI personal config
## see ## see
# https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#setting-up-modules # https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#setting-up-modules
@ -117,7 +128,8 @@ class example:
### you can insert your own configuration below ### you can insert your own configuration below
### but feel free to delete the stuff above if you don't need ti ### but feel free to delete the stuff above if you don't need ti
'''.lstrip()) '''.lstrip()
)
info(f'created empty config: {my_config}') info(f'created empty config: {my_config}')
created = True created = True
else: else:
@ -130,12 +142,13 @@ class example:
# todo return the config as a result? # todo return the config as a result?
def config_ok() -> bool: def config_ok() -> bool:
errors: List[Exception] = [] errors: list[Exception] = []
# at this point 'my' should already be imported, so doesn't hurt to extract paths from it # at this point 'my' should already be imported, so doesn't hurt to extract paths from it
import my import my
try: try:
paths: List[str] = list(my.__path__) paths: list[str] = list(my.__path__)
except Exception as e: except Exception as e:
errors.append(e) errors.append(e)
error('failed to determine module import path') error('failed to determine module import path')
@ -145,19 +158,23 @@ def config_ok() -> bool:
# first try doing as much as possible without actually importing my.config # first try doing as much as possible without actually importing my.config
from .preinit import get_mycfg_dir from .preinit import get_mycfg_dir
cfg_path = get_mycfg_dir() cfg_path = get_mycfg_dir()
# alternative is importing my.config and then getting cfg_path from its __file__/__path__ # alternative is importing my.config and then getting cfg_path from its __file__/__path__
# not sure which is better tbh # not sure which is better tbh
## check we're not using stub config ## check we're not using stub config
import my.core import my.core
try: try:
core_pkg_path = str(Path(my.core.__path__[0]).parent) core_pkg_path = str(Path(my.core.__path__[0]).parent)
if str(cfg_path).startswith(core_pkg_path): if str(cfg_path).startswith(core_pkg_path):
error(f''' error(
f'''
Seems that the stub config is used ({cfg_path}). This is likely not going to work. Seems that the stub config is used ({cfg_path}). This is likely not going to work.
See https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#setting-up-modules for more information See https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#setting-up-modules for more information
'''.strip()) '''.strip()
)
errors.append(RuntimeError('bad config path')) errors.append(RuntimeError('bad config path'))
except Exception as e: except Exception as e:
errors.append(e) errors.append(e)
@ -189,7 +206,7 @@ See https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#setting-up-module
## check types ## check types
mypy_res = run_mypy(cfg_path) mypy_res = run_mypy(cfg_path)
if mypy_res is not None: # has mypy if mypy_res is not None: # has mypy
rc = mypy_res.returncode rc = mypy_res.returncode
if rc == 0: if rc == 0:
info('mypy check : success') info('mypy check : success')
@ -221,7 +238,7 @@ See https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#setting-up-module
from .util import HPIModule, modules from .util import HPIModule, modules
def _modules(*, all: bool=False) -> Iterable[HPIModule]: def _modules(*, all: bool = False) -> Iterable[HPIModule]:
skipped = [] skipped = []
for m in modules(): for m in modules():
if not all and m.skip_reason is not None: if not all and m.skip_reason is not None:
@ -232,7 +249,7 @@ def _modules(*, all: bool=False) -> Iterable[HPIModule]:
warning(f'Skipped {len(skipped)} modules: {skipped}. Pass --all if you want to see them.') warning(f'Skipped {len(skipped)} modules: {skipped}. Pass --all if you want to see them.')
def modules_check(*, verbose: bool, list_all: bool, quick: bool, for_modules: List[str]) -> None: def modules_check(*, verbose: bool, list_all: bool, quick: bool, for_modules: list[str]) -> None:
if len(for_modules) > 0: if len(for_modules) > 0:
# if you're checking specific modules, show errors # if you're checking specific modules, show errors
# hopefully makes sense? # hopefully makes sense?
@ -256,7 +273,7 @@ def modules_check(*, verbose: bool, list_all: bool, quick: bool, for_modules: Li
# todo add a --all argument to disregard is_active check? # todo add a --all argument to disregard is_active check?
for mr in mods: for mr in mods:
skip = mr.skip_reason skip = mr.skip_reason
m = mr.name m = mr.name
if skip is not None: if skip is not None:
eprint(f'{OFF} {click.style("SKIP", fg="yellow")}: {m:<50} {skip}') eprint(f'{OFF} {click.style("SKIP", fg="yellow")}: {m:<50} {skip}')
continue continue
@ -306,8 +323,8 @@ def list_modules(*, list_all: bool) -> None:
tabulate_warnings() tabulate_warnings()
for mr in _modules(all=list_all): for mr in _modules(all=list_all):
m = mr.name m = mr.name
sr = mr.skip_reason sr = mr.skip_reason
if sr is None: if sr is None:
pre = OK pre = OK
suf = '' suf = ''
@ -323,17 +340,20 @@ def tabulate_warnings() -> None:
Helper to avoid visual noise in hpi modules/doctor Helper to avoid visual noise in hpi modules/doctor
''' '''
import warnings import warnings
orig = warnings.formatwarning orig = warnings.formatwarning
def override(*args, **kwargs) -> str: def override(*args, **kwargs) -> str:
res = orig(*args, **kwargs) res = orig(*args, **kwargs)
return ''.join(' ' + x for x in res.splitlines(keepends=True)) return ''.join(' ' + x for x in res.splitlines(keepends=True))
warnings.formatwarning = override warnings.formatwarning = override
# TODO loggers as well? # TODO loggers as well?
def _requires(modules: Sequence[str]) -> Sequence[str]: def _requires(modules: Sequence[str]) -> Sequence[str]:
from .discovery_pure import module_by_name from .discovery_pure import module_by_name
mods = [module_by_name(module) for module in modules] mods = [module_by_name(module) for module in modules]
res = [] res = []
for mod in mods: for mod in mods:
@ -360,7 +380,7 @@ def module_requires(*, module: Sequence[str]) -> None:
click.echo(x) click.echo(x)
def module_install(*, user: bool, module: Sequence[str], parallel: bool=False, break_system_packages: bool=False) -> None: def module_install(*, user: bool, module: Sequence[str], parallel: bool = False, break_system_packages: bool = False) -> None:
if isinstance(module, str): if isinstance(module, str):
# legacy behavior, used to take a since argument # legacy behavior, used to take a since argument
module = [module] module = [module]
@ -437,7 +457,7 @@ def _ui_getchar_pick(choices: Sequence[str], prompt: str = 'Select from: ') -> i
return result_map[ch] return result_map[ch]
def _locate_functions_or_prompt(qualified_names: List[str], *, prompt: bool = True) -> Iterable[Callable[..., Any]]: def _locate_functions_or_prompt(qualified_names: list[str], *, prompt: bool = True) -> Iterable[Callable[..., Any]]:
from .query import QueryException, locate_qualified_function from .query import QueryException, locate_qualified_function
from .stats import is_data_provider from .stats import is_data_provider
@ -487,6 +507,7 @@ def _locate_functions_or_prompt(qualified_names: List[str], *, prompt: bool = Tr
def _warn_exceptions(exc: Exception) -> None: def _warn_exceptions(exc: Exception) -> None:
from my.core import make_logger from my.core import make_logger
logger = make_logger('CLI', level='warning') logger = make_logger('CLI', level='warning')
logger.exception(f'hpi query: {exc}') logger.exception(f'hpi query: {exc}')
@ -498,14 +519,14 @@ def query_hpi_functions(
*, *,
output: str = 'json', output: str = 'json',
stream: bool = False, stream: bool = False,
qualified_names: List[str], qualified_names: list[str],
order_key: Optional[str], order_key: str | None,
order_by_value_type: Optional[Type], order_by_value_type: type | None,
after: Any, after: Any,
before: Any, before: Any,
within: Any, within: Any,
reverse: bool = False, reverse: bool = False,
limit: Optional[int], limit: int | None,
drop_unsorted: bool, drop_unsorted: bool,
wrap_unsorted: bool, wrap_unsorted: bool,
warn_exceptions: bool, warn_exceptions: bool,
@ -517,6 +538,9 @@ def query_hpi_functions(
# chain list of functions from user, in the order they wrote them on the CLI # chain list of functions from user, in the order they wrote them on the CLI
input_src = chain(*(f() for f in _locate_functions_or_prompt(qualified_names))) input_src = chain(*(f() for f in _locate_functions_or_prompt(qualified_names)))
# NOTE: if passing just one function to this which returns a single namedtuple/dataclass,
# using both --order-key and --order-type will often be faster as it does not need to
# duplicate the iterator in memory, or try to find the --order-type type on each object before sorting
res = select_range( res = select_range(
input_src, input_src,
order_key=order_key, order_key=order_key,
@ -529,7 +553,8 @@ def query_hpi_functions(
warn_exceptions=warn_exceptions, warn_exceptions=warn_exceptions,
warn_func=_warn_exceptions, warn_func=_warn_exceptions,
raise_exceptions=raise_exceptions, raise_exceptions=raise_exceptions,
drop_exceptions=drop_exceptions) drop_exceptions=drop_exceptions,
)
if output == 'json': if output == 'json':
from .serialize import dumps from .serialize import dumps
@ -563,7 +588,7 @@ def query_hpi_functions(
# can ignore the mypy warning here, locations_to_gpx yields any errors # can ignore the mypy warning here, locations_to_gpx yields any errors
# if you didnt pass it something that matches the LocationProtocol # if you didnt pass it something that matches the LocationProtocol
for exc in locations_to_gpx(res, sys.stdout): # type: ignore[arg-type] for exc in locations_to_gpx(res, sys.stdout): # type: ignore[arg-type]
if warn_exceptions: if warn_exceptions:
_warn_exceptions(exc) _warn_exceptions(exc)
elif raise_exceptions: elif raise_exceptions:
@ -580,6 +605,7 @@ def query_hpi_functions(
except ModuleNotFoundError: except ModuleNotFoundError:
eprint("'repl' typically uses ipython, install it with 'python3 -m pip install ipython'. falling back to stdlib...") eprint("'repl' typically uses ipython, install it with 'python3 -m pip install ipython'. falling back to stdlib...")
import code import code
code.interact(local=locals()) code.interact(local=locals())
else: else:
IPython.embed() IPython.embed()
@ -619,13 +645,13 @@ def main(*, debug: bool) -> None:
@functools.lru_cache(maxsize=1) @functools.lru_cache(maxsize=1)
def _all_mod_names() -> List[str]: def _all_mod_names() -> list[str]:
"""Should include all modules, in case user is trying to diagnose issues""" """Should include all modules, in case user is trying to diagnose issues"""
# sort this, so that the order doesn't change while tabbing through # sort this, so that the order doesn't change while tabbing through
return sorted([m.name for m in modules()]) return sorted([m.name for m in modules()])
def _module_autocomplete(ctx: click.Context, args: Sequence[str], incomplete: str) -> List[str]: def _module_autocomplete(ctx: click.Context, args: Sequence[str], incomplete: str) -> list[str]:
return [m for m in _all_mod_names() if m.startswith(incomplete)] return [m for m in _all_mod_names() if m.startswith(incomplete)]
@ -784,14 +810,14 @@ def query_cmd(
function_name: Sequence[str], function_name: Sequence[str],
output: str, output: str,
stream: bool, stream: bool,
order_key: Optional[str], order_key: str | None,
order_type: Optional[str], order_type: str | None,
after: Optional[str], after: str | None,
before: Optional[str], before: str | None,
within: Optional[str], within: str | None,
recent: Optional[str], recent: str | None,
reverse: bool, reverse: bool,
limit: Optional[int], limit: int | None,
drop_unsorted: bool, drop_unsorted: bool,
wrap_unsorted: bool, wrap_unsorted: bool,
warn_exceptions: bool, warn_exceptions: bool,
@ -827,7 +853,7 @@ def query_cmd(
from datetime import date, datetime from datetime import date, datetime
chosen_order_type: Optional[Type] chosen_order_type: type | None
if order_type == "datetime": if order_type == "datetime":
chosen_order_type = datetime chosen_order_type = datetime
elif order_type == "date": elif order_type == "date":
@ -863,7 +889,8 @@ def query_cmd(
wrap_unsorted=wrap_unsorted, wrap_unsorted=wrap_unsorted,
warn_exceptions=warn_exceptions, warn_exceptions=warn_exceptions,
raise_exceptions=raise_exceptions, raise_exceptions=raise_exceptions,
drop_exceptions=drop_exceptions) drop_exceptions=drop_exceptions,
)
except QueryException as qe: except QueryException as qe:
eprint(str(qe)) eprint(str(qe))
sys.exit(1) sys.exit(1)
@ -878,6 +905,7 @@ def query_cmd(
def test_requires() -> None: def test_requires() -> None:
from click.testing import CliRunner from click.testing import CliRunner
result = CliRunner().invoke(main, ['module', 'requires', 'my.github.ghexport', 'my.browser.export']) result = CliRunner().invoke(main, ['module', 'requires', 'my.github.ghexport', 'my.browser.export'])
assert result.exit_code == 0 assert result.exit_code == 0
assert "github.com/karlicoss/ghexport" in result.output assert "github.com/karlicoss/ghexport" in result.output

View file

@ -10,15 +10,18 @@ how many cores we want to dedicate to the DAL.
Enabled by the env variable, specifying how many cores to dedicate Enabled by the env variable, specifying how many cores to dedicate
e.g. "HPI_CPU_POOL=4 hpi query ..." e.g. "HPI_CPU_POOL=4 hpi query ..."
""" """
from __future__ import annotations
import os import os
from concurrent.futures import ProcessPoolExecutor from concurrent.futures import ProcessPoolExecutor
from typing import Optional, cast from typing import cast
_NOT_SET = cast(ProcessPoolExecutor, object()) _NOT_SET = cast(ProcessPoolExecutor, object())
_INSTANCE: Optional[ProcessPoolExecutor] = _NOT_SET _INSTANCE: ProcessPoolExecutor | None = _NOT_SET
def get_cpu_pool() -> Optional[ProcessPoolExecutor]: def get_cpu_pool() -> ProcessPoolExecutor | None:
global _INSTANCE global _INSTANCE
if _INSTANCE is _NOT_SET: if _INSTANCE is _NOT_SET:
use_cpu_pool = os.environ.get('HPI_CPU_POOL') use_cpu_pool = os.environ.get('HPI_CPU_POOL')

View file

@ -1,16 +1,17 @@
""" """
Various helpers for compression Various helpers for compression
""" """
# fmt: off # fmt: off
from __future__ import annotations from __future__ import annotations
import io import io
import pathlib import pathlib
import sys from collections.abc import Iterator, Sequence
from datetime import datetime from datetime import datetime
from functools import total_ordering from functools import total_ordering
from pathlib import Path from pathlib import Path
from typing import IO, Any, Iterator, Sequence, Union from typing import IO, Union
PathIsh = Union[Path, str] PathIsh = Union[Path, str]

View file

@ -1,16 +1,18 @@
from .internal import assert_subpackage; assert_subpackage(__name__) from __future__ import annotations
from .internal import assert_subpackage
assert_subpackage(__name__)
import logging import logging
import sys import sys
from collections.abc import Iterator
from contextlib import contextmanager from contextlib import contextmanager
from pathlib import Path from pathlib import Path
from typing import ( from typing import (
TYPE_CHECKING, TYPE_CHECKING,
Any, Any,
Callable, Callable,
Iterator,
Optional,
Type,
TypeVar, TypeVar,
Union, Union,
cast, cast,
@ -21,7 +23,6 @@ import appdirs # type: ignore[import-untyped]
from . import warnings from . import warnings
PathIsh = Union[str, Path] # avoid circular import from .common PathIsh = Union[str, Path] # avoid circular import from .common
@ -60,12 +61,12 @@ def _appdirs_cache_dir() -> Path:
_CACHE_DIR_NONE_HACK = Path('/tmp/hpi/cachew_none_hack') _CACHE_DIR_NONE_HACK = Path('/tmp/hpi/cachew_none_hack')
def cache_dir(suffix: Optional[PathIsh] = None) -> Path: def cache_dir(suffix: PathIsh | None = None) -> Path:
from . import core_config as CC from . import core_config as CC
cdir_ = CC.config.get_cache_dir() cdir_ = CC.config.get_cache_dir()
sp: Optional[Path] = None sp: Path | None = None
if suffix is not None: if suffix is not None:
sp = Path(suffix) sp = Path(suffix)
# guess if you do need absolute, better path it directly instead of as suffix? # guess if you do need absolute, better path it directly instead of as suffix?
@ -135,7 +136,7 @@ if TYPE_CHECKING:
CC = Callable[P, R] # need to give it a name, if inlined into bound=, mypy runs in a bug CC = Callable[P, R] # need to give it a name, if inlined into bound=, mypy runs in a bug
PathProvider = Union[PathIsh, Callable[P, PathIsh]] PathProvider = Union[PathIsh, Callable[P, PathIsh]]
# NOTE: in cachew, HashFunction type returns str # NOTE: in cachew, HashFunction type returns str
# however in practice, cachew alwasy calls str for its result # however in practice, cachew always calls str for its result
# so perhaps better to switch it to Any in cachew as well # so perhaps better to switch it to Any in cachew as well
HashFunction = Callable[P, Any] HashFunction = Callable[P, Any]
@ -144,21 +145,19 @@ if TYPE_CHECKING:
# we need two versions due to @doublewrap # we need two versions due to @doublewrap
# this is when we just annotate as @cachew without any args # this is when we just annotate as @cachew without any args
@overload # type: ignore[no-overload-impl] @overload # type: ignore[no-overload-impl]
def mcachew(fun: F) -> F: def mcachew(fun: F) -> F: ...
...
@overload @overload
def mcachew( def mcachew(
cache_path: Optional[PathProvider] = ..., cache_path: PathProvider | None = ...,
*, *,
force_file: bool = ..., force_file: bool = ...,
cls: Optional[Type] = ..., cls: type | None = ...,
depends_on: HashFunction = ..., depends_on: HashFunction = ...,
logger: Optional[logging.Logger] = ..., logger: logging.Logger | None = ...,
chunk_by: int = ..., chunk_by: int = ...,
synthetic_key: Optional[str] = ..., synthetic_key: str | None = ...,
) -> Callable[[F], F]: ) -> Callable[[F], F]: ...
...
else: else:
mcachew = _mcachew_impl mcachew = _mcachew_impl

View file

@ -3,28 +3,32 @@ from __future__ import annotations
import importlib import importlib
import re import re
import sys import sys
from collections.abc import Iterator
from contextlib import ExitStack, contextmanager from contextlib import ExitStack, contextmanager
from typing import Any, Callable, Dict, Iterator, Optional, Type, TypeVar from typing import Any, Callable, TypeVar
Attrs = Dict[str, Any] Attrs = dict[str, Any]
C = TypeVar('C') C = TypeVar('C')
# todo not sure about it, could be overthinking... # todo not sure about it, could be overthinking...
# but short enough to change later # but short enough to change later
# TODO document why it's necessary? # TODO document why it's necessary?
def make_config(cls: Type[C], migration: Callable[[Attrs], Attrs]=lambda x: x) -> C: def make_config(cls: type[C], migration: Callable[[Attrs], Attrs] = lambda x: x) -> C:
user_config = cls.__base__ user_config = cls.__base__
old_props = { old_props = {
# NOTE: deliberately use gettatr to 'force' class properties here # NOTE: deliberately use gettatr to 'force' class properties here
k: getattr(user_config, k) for k in vars(user_config) k: getattr(user_config, k)
for k in vars(user_config)
} }
new_props = migration(old_props) new_props = migration(old_props)
from dataclasses import fields from dataclasses import fields
params = { params = {
k: v k: v
for k, v in new_props.items() for k, v in new_props.items()
if k in {f.name for f in fields(cls)} # type: ignore[arg-type] # see https://github.com/python/typing_extensions/issues/115 if k in {f.name for f in fields(cls)} # type: ignore[arg-type] # see https://github.com/python/typing_extensions/issues/115
} }
# todo maybe return type here? # todo maybe return type here?
return cls(**params) return cls(**params)
@ -51,6 +55,8 @@ def _override_config(config: F) -> Iterator[F]:
ModuleRegex = str ModuleRegex = str
@contextmanager @contextmanager
def _reload_modules(modules: ModuleRegex) -> Iterator[None]: def _reload_modules(modules: ModuleRegex) -> Iterator[None]:
# need to use list here, otherwise reordering with set might mess things up # need to use list here, otherwise reordering with set might mess things up
@ -81,13 +87,14 @@ def _reload_modules(modules: ModuleRegex) -> Iterator[None]:
@contextmanager @contextmanager
def tmp_config(*, modules: Optional[ModuleRegex]=None, config=None): def tmp_config(*, modules: ModuleRegex | None = None, config=None):
if modules is None: if modules is None:
assert config is None assert config is None
if modules is not None: if modules is not None:
assert config is not None assert config is not None
import my.config import my.config
with ExitStack() as module_reload_stack, _override_config(my.config) as new_config: with ExitStack() as module_reload_stack, _override_config(my.config) as new_config:
if config is not None: if config is not None:
overrides = {k: v for k, v in vars(config).items() if not k.startswith('__')} overrides = {k: v for k, v in vars(config).items() if not k.startswith('__')}
@ -102,6 +109,7 @@ def tmp_config(*, modules: Optional[ModuleRegex]=None, config=None):
def test_tmp_config() -> None: def test_tmp_config() -> None:
class extra: class extra:
data_path = '/path/to/data' data_path = '/path/to/data'
with tmp_config() as c: with tmp_config() as c:
assert c.google != 'whatever' assert c.google != 'whatever'
assert not hasattr(c, 'extra') assert not hasattr(c, 'extra')

View file

@ -1,20 +1,18 @@
from __future__ import annotations
import os import os
from collections.abc import Iterable, Sequence
from glob import glob as do_glob from glob import glob as do_glob
from pathlib import Path from pathlib import Path
from typing import ( from typing import (
TYPE_CHECKING, TYPE_CHECKING,
Callable, Callable,
Generic, Generic,
Iterable,
List,
Sequence,
Tuple,
TypeVar, TypeVar,
Union, Union,
) )
from . import compat from . import compat, warnings
from . import warnings
# some helper functions # some helper functions
# TODO start deprecating this? soon we'd be able to use Path | str syntax which is shorter and more explicit # TODO start deprecating this? soon we'd be able to use Path | str syntax which is shorter and more explicit
@ -24,20 +22,22 @@ Paths = Union[Sequence[PathIsh], PathIsh]
DEFAULT_GLOB = '*' DEFAULT_GLOB = '*'
def get_files( def get_files(
pp: Paths, pp: Paths,
glob: str=DEFAULT_GLOB, glob: str = DEFAULT_GLOB,
*, *,
sort: bool=True, sort: bool = True,
guess_compression: bool=True, guess_compression: bool = True,
) -> Tuple[Path, ...]: ) -> tuple[Path, ...]:
""" """
Helper function to avoid boilerplate. Helper function to avoid boilerplate.
Tuple as return type is a bit friendlier for hashing/caching, so hopefully makes sense Tuple as return type is a bit friendlier for hashing/caching, so hopefully makes sense
""" """
# TODO FIXME mm, some wrapper to assert iterator isn't empty? # TODO FIXME mm, some wrapper to assert iterator isn't empty?
sources: List[Path] sources: list[Path]
if isinstance(pp, Path): if isinstance(pp, Path):
sources = [pp] sources = [pp]
elif isinstance(pp, str): elif isinstance(pp, str):
@ -54,7 +54,7 @@ def get_files(
# TODO ugh. very flaky... -3 because [<this function>, get_files(), <actual caller>] # TODO ugh. very flaky... -3 because [<this function>, get_files(), <actual caller>]
return traceback.extract_stack()[-3].filename return traceback.extract_stack()[-3].filename
paths: List[Path] = [] paths: list[Path] = []
for src in sources: for src in sources:
if src.parts[0] == '~': if src.parts[0] == '~':
src = src.expanduser() src = src.expanduser()
@ -63,8 +63,8 @@ def get_files(
if '*' in gs: if '*' in gs:
if glob != DEFAULT_GLOB: if glob != DEFAULT_GLOB:
warnings.medium(f"{caller()}: treating {gs} as glob path. Explicit glob={glob} argument is ignored!") warnings.medium(f"{caller()}: treating {gs} as glob path. Explicit glob={glob} argument is ignored!")
paths.extend(map(Path, do_glob(gs))) paths.extend(map(Path, do_glob(gs))) # noqa: PTH207
elif os.path.isdir(str(src)): elif os.path.isdir(str(src)): # noqa: PTH112
# NOTE: we're using os.path here on purpose instead of src.is_dir # NOTE: we're using os.path here on purpose instead of src.is_dir
# the reason is is_dir for archives might return True and then # the reason is is_dir for archives might return True and then
# this clause would try globbing insize the archives # this clause would try globbing insize the archives
@ -157,7 +157,7 @@ def get_valid_filename(s: str) -> str:
# TODO deprecate and suggest to use one from my.core directly? not sure # TODO deprecate and suggest to use one from my.core directly? not sure
from .utils.itertools import unique_everseen from .utils.itertools import unique_everseen # noqa: F401
### legacy imports, keeping them here for backwards compatibility ### legacy imports, keeping them here for backwards compatibility
## hiding behind TYPE_CHECKING so it works in runtime ## hiding behind TYPE_CHECKING so it works in runtime
@ -234,16 +234,14 @@ if not TYPE_CHECKING:
return types.asdict(*args, **kwargs) return types.asdict(*args, **kwargs)
# todo wrap these in deprecated decorator as well? # todo wrap these in deprecated decorator as well?
# TODO hmm how to deprecate these in runtime?
# tricky cause they are actually classes/types
from typing import Literal # noqa: F401
from .cachew import mcachew # noqa: F401 from .cachew import mcachew # noqa: F401
# this is kinda internal, should just use my.core.logging.setup_logger if necessary # this is kinda internal, should just use my.core.logging.setup_logger if necessary
from .logging import setup_logger from .logging import setup_logger
# TODO hmm how to deprecate these in runtime?
# tricky cause they are actually classes/types
from typing import Literal # noqa: F401
from .stats import Stats from .stats import Stats
from .types import ( from .types import (
Json, Json,

View file

@ -3,6 +3,8 @@ Contains backwards compatibility helpers for different python versions.
If something is relevant to HPI itself, please put it in .hpi_compat instead If something is relevant to HPI itself, please put it in .hpi_compat instead
''' '''
from __future__ import annotations
import sys import sys
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
@ -29,6 +31,7 @@ if not TYPE_CHECKING:
@deprecated('use .removesuffix method on string directly instead') @deprecated('use .removesuffix method on string directly instead')
def removesuffix(text: str, suffix: str) -> str: def removesuffix(text: str, suffix: str) -> str:
return text.removesuffix(suffix) return text.removesuffix(suffix)
## ##
## used to have compat function before 3.8 for these, keeping for runtime back compatibility ## used to have compat function before 3.8 for these, keeping for runtime back compatibility
@ -46,13 +49,13 @@ else:
# bisect_left doesn't have a 'key' parameter (which we use) # bisect_left doesn't have a 'key' parameter (which we use)
# till python3.10 # till python3.10
if sys.version_info[:2] <= (3, 9): if sys.version_info[:2] <= (3, 9):
from typing import Any, Callable, List, Optional, TypeVar from typing import Any, Callable, List, Optional, TypeVar # noqa: UP035
X = TypeVar('X') X = TypeVar('X')
# copied from python src # copied from python src
# fmt: off # fmt: off
def bisect_left(a: List[Any], x: Any, lo: int=0, hi: Optional[int]=None, *, key: Optional[Callable[..., Any]]=None) -> int: def bisect_left(a: list[Any], x: Any, lo: int=0, hi: int | None=None, *, key: Callable[..., Any] | None=None) -> int:
if lo < 0: if lo < 0:
raise ValueError('lo must be non-negative') raise ValueError('lo must be non-negative')
if hi is None: if hi is None:

View file

@ -2,18 +2,21 @@
Bindings for the 'core' HPI configuration Bindings for the 'core' HPI configuration
''' '''
from __future__ import annotations
import re import re
from collections.abc import Sequence
from dataclasses import dataclass from dataclasses import dataclass
from pathlib import Path from pathlib import Path
from typing import Optional, Sequence
from . import PathIsh, warnings from . import warnings
try: try:
from my.config import core as user_config # type: ignore[attr-defined] from my.config import core as user_config # type: ignore[attr-defined]
except Exception as e: except Exception as e:
try: try:
from my.config import common as user_config # type: ignore[attr-defined] from my.config import common as user_config # type: ignore[attr-defined]
warnings.high("'common' config section is deprecated. Please rename it to 'core'.") warnings.high("'common' config section is deprecated. Please rename it to 'core'.")
except Exception as e2: except Exception as e2:
# make it defensive, because it's pretty commonly used and would be annoying if it breaks hpi doctor etc. # make it defensive, because it's pretty commonly used and would be annoying if it breaks hpi doctor etc.
@ -24,6 +27,7 @@ except Exception as e:
_HPI_CACHE_DIR_DEFAULT = '' _HPI_CACHE_DIR_DEFAULT = ''
@dataclass @dataclass
class Config(user_config): class Config(user_config):
''' '''
@ -34,7 +38,7 @@ class Config(user_config):
cache_dir = '/your/custom/cache/path' cache_dir = '/your/custom/cache/path'
''' '''
cache_dir: Optional[PathIsh] = _HPI_CACHE_DIR_DEFAULT cache_dir: Path | str | None = _HPI_CACHE_DIR_DEFAULT
''' '''
Base directory for cachew. Base directory for cachew.
- if None , means cache is disabled - if None , means cache is disabled
@ -44,7 +48,7 @@ class Config(user_config):
NOTE: you shouldn't use this attribute in HPI modules directly, use Config.get_cache_dir()/cachew.cache_dir() instead NOTE: you shouldn't use this attribute in HPI modules directly, use Config.get_cache_dir()/cachew.cache_dir() instead
''' '''
tmp_dir: Optional[PathIsh] = None tmp_dir: Path | str | None = None
''' '''
Path to a temporary directory. Path to a temporary directory.
This can be used temporarily while extracting zipfiles etc... This can be used temporarily while extracting zipfiles etc...
@ -52,34 +56,36 @@ class Config(user_config):
- otherwise , use the specified directory as the base temporary directory - otherwise , use the specified directory as the base temporary directory
''' '''
enabled_modules : Optional[Sequence[str]] = None enabled_modules: Sequence[str] | None = None
''' '''
list of regexes/globs list of regexes/globs
- None means 'rely on disabled_modules' - None means 'rely on disabled_modules'
''' '''
disabled_modules: Optional[Sequence[str]] = None disabled_modules: Sequence[str] | None = None
''' '''
list of regexes/globs list of regexes/globs
- None means 'rely on enabled_modules' - None means 'rely on enabled_modules'
''' '''
def get_cache_dir(self) -> Optional[Path]: def get_cache_dir(self) -> Path | None:
cdir = self.cache_dir cdir = self.cache_dir
if cdir is None: if cdir is None:
return None return None
if cdir == _HPI_CACHE_DIR_DEFAULT: if cdir == _HPI_CACHE_DIR_DEFAULT:
from .cachew import _appdirs_cache_dir from .cachew import _appdirs_cache_dir
return _appdirs_cache_dir() return _appdirs_cache_dir()
else: else:
return Path(cdir).expanduser() return Path(cdir).expanduser()
def get_tmp_dir(self) -> Path: def get_tmp_dir(self) -> Path:
tdir: Optional[PathIsh] = self.tmp_dir tdir: Path | str | None = self.tmp_dir
tpath: Path tpath: Path
# use tempfile if unset # use tempfile if unset
if tdir is None: if tdir is None:
import tempfile import tempfile
tpath = Path(tempfile.gettempdir()) / 'HPI' tpath = Path(tempfile.gettempdir()) / 'HPI'
else: else:
tpath = Path(tdir) tpath = Path(tdir)
@ -87,10 +93,10 @@ class Config(user_config):
tpath.mkdir(parents=True, exist_ok=True) tpath.mkdir(parents=True, exist_ok=True)
return tpath return tpath
def _is_module_active(self, module: str) -> Optional[bool]: def _is_module_active(self, module: str) -> bool | None:
# None means the config doesn't specify anything # None means the config doesn't specify anything
# todo might be nice to return the 'reason' too? e.g. which option has matched # todo might be nice to return the 'reason' too? e.g. which option has matched
def matches(specs: Sequence[str]) -> Optional[str]: def matches(specs: Sequence[str]) -> str | None:
for spec in specs: for spec in specs:
# not sure because . (packages separate) matches anything, but I guess unlikely to clash # not sure because . (packages separate) matches anything, but I guess unlikely to clash
if re.match(spec, module): if re.match(spec, module):
@ -106,10 +112,10 @@ class Config(user_config):
return None return None
else: else:
return False return False
else: # not None else: # not None
if off is None: if off is None:
return True return True
else: # not None else: # not None
# fallback onto the 'enable everything', then the user will notice # fallback onto the 'enable everything', then the user will notice
warnings.medium(f"[module]: conflicting regexes '{on}' and '{off}' are set in the config. Please only use one of them.") warnings.medium(f"[module]: conflicting regexes '{on}' and '{off}' are set in the config. Please only use one of them.")
return True return True
@ -121,8 +127,8 @@ config = make_config(Config)
### tests start ### tests start
from collections.abc import Iterator
from contextlib import contextmanager as ctx from contextlib import contextmanager as ctx
from typing import Iterator
@ctx @ctx
@ -163,4 +169,5 @@ def test_active_modules() -> None:
assert cc._is_module_active("my.body.exercise") is True assert cc._is_module_active("my.body.exercise") is True
assert len(record_warnings) == 1 assert len(record_warnings) == 1
### tests end ### tests end

View file

@ -5,23 +5,25 @@ A helper module for defining denylists for sources programmatically
For docs, see doc/DENYLIST.md For docs, see doc/DENYLIST.md
""" """
from __future__ import annotations
import functools import functools
import json import json
import sys import sys
from collections import defaultdict from collections import defaultdict
from collections.abc import Iterator, Mapping
from pathlib import Path from pathlib import Path
from typing import Any, Dict, Iterator, List, Mapping, Set, TypeVar from typing import Any, TypeVar
import click import click
from more_itertools import seekable from more_itertools import seekable
from my.core.common import PathIsh from .serialize import dumps
from my.core.serialize import dumps from .warnings import medium
from my.core.warnings import medium
T = TypeVar("T") T = TypeVar("T")
DenyMap = Mapping[str, Set[Any]] DenyMap = Mapping[str, set[Any]]
def _default_key_func(obj: T) -> str: def _default_key_func(obj: T) -> str:
@ -29,9 +31,9 @@ def _default_key_func(obj: T) -> str:
class DenyList: class DenyList:
def __init__(self, denylist_file: PathIsh): def __init__(self, denylist_file: Path | str) -> None:
self.file = Path(denylist_file).expanduser().absolute() self.file = Path(denylist_file).expanduser().absolute()
self._deny_raw_list: List[Dict[str, Any]] = [] self._deny_raw_list: list[dict[str, Any]] = []
self._deny_map: DenyMap = defaultdict(set) self._deny_map: DenyMap = defaultdict(set)
# deny cli, user can override these # deny cli, user can override these
@ -45,7 +47,7 @@ class DenyList:
return return
deny_map: DenyMap = defaultdict(set) deny_map: DenyMap = defaultdict(set)
data: List[Dict[str, Any]]= json.loads(self.file.read_text()) data: list[dict[str, Any]] = json.loads(self.file.read_text())
self._deny_raw_list = data self._deny_raw_list = data
for ignore in data: for ignore in data:
@ -112,7 +114,7 @@ class DenyList:
self._load() self._load()
self._deny_raw({key: self._stringify_value(value)}, write=write) self._deny_raw({key: self._stringify_value(value)}, write=write)
def _deny_raw(self, data: Dict[str, Any], *, write: bool = False) -> None: def _deny_raw(self, data: dict[str, Any], *, write: bool = False) -> None:
self._deny_raw_list.append(data) self._deny_raw_list.append(data)
if write: if write:
self.write() self.write()
@ -131,7 +133,7 @@ class DenyList:
def _deny_cli_remember( def _deny_cli_remember(
self, self,
items: Iterator[T], items: Iterator[T],
mem: Dict[str, T], mem: dict[str, T],
) -> Iterator[str]: ) -> Iterator[str]:
keyf = self._deny_cli_key_func or _default_key_func keyf = self._deny_cli_key_func or _default_key_func
# i.e., convert each item to a string, and map str -> item # i.e., convert each item to a string, and map str -> item
@ -157,10 +159,8 @@ class DenyList:
# reset the iterator # reset the iterator
sit.seek(0) sit.seek(0)
# so we can map the selected string from fzf back to the original objects # so we can map the selected string from fzf back to the original objects
memory_map: Dict[str, T] = {} memory_map: dict[str, T] = {}
picker = FzfPrompt( picker = FzfPrompt(executable_path=self.fzf_path, default_options="--no-multi")
executable_path=self.fzf_path, default_options="--no-multi"
)
picked_l = picker.prompt( picked_l = picker.prompt(
self._deny_cli_remember(itr, memory_map), self._deny_cli_remember(itr, memory_map),
"--read0", "--read0",

View file

@ -10,6 +10,8 @@ This potentially allows it to be:
It should be free of external modules, importlib, exec, etc. etc. It should be free of external modules, importlib, exec, etc. etc.
''' '''
from __future__ import annotations
REQUIRES = 'REQUIRES' REQUIRES = 'REQUIRES'
NOT_HPI_MODULE_VAR = '__NOT_HPI_MODULE__' NOT_HPI_MODULE_VAR = '__NOT_HPI_MODULE__'
@ -19,8 +21,9 @@ import ast
import logging import logging
import os import os
import re import re
from collections.abc import Iterable, Sequence
from pathlib import Path from pathlib import Path
from typing import Any, Iterable, List, NamedTuple, Optional, Sequence, cast from typing import Any, NamedTuple, Optional, cast
''' '''
None means that requirements weren't defined (different from empty requirements) None means that requirements weren't defined (different from empty requirements)
@ -30,11 +33,11 @@ Requires = Optional[Sequence[str]]
class HPIModule(NamedTuple): class HPIModule(NamedTuple):
name: str name: str
skip_reason: Optional[str] skip_reason: str | None
doc: Optional[str] = None doc: str | None = None
file: Optional[Path] = None file: Path | None = None
requires: Requires = None requires: Requires = None
legacy: Optional[str] = None # contains reason/deprecation warning legacy: str | None = None # contains reason/deprecation warning
def ignored(m: str) -> bool: def ignored(m: str) -> bool:
@ -55,13 +58,13 @@ def has_stats(src: Path) -> bool:
def _has_stats(code: str) -> bool: def _has_stats(code: str) -> bool:
a: ast.Module = ast.parse(code) a: ast.Module = ast.parse(code)
for x in a.body: for x in a.body:
try: # maybe assign try: # maybe assign
[tg] = cast(Any, x).targets [tg] = cast(Any, x).targets
if tg.id == 'stats': if tg.id == 'stats':
return True return True
except: except:
pass pass
try: # maybe def? try: # maybe def?
name = cast(Any, x).name name = cast(Any, x).name
if name == 'stats': if name == 'stats':
return True return True
@ -144,7 +147,7 @@ def all_modules() -> Iterable[HPIModule]:
def _iter_my_roots() -> Iterable[Path]: def _iter_my_roots() -> Iterable[Path]:
import my # doesn't import any code, because of namespace package import my # doesn't import any code, because of namespace package
paths: List[str] = list(my.__path__) paths: list[str] = list(my.__path__)
if len(paths) == 0: if len(paths) == 0:
# should probably never happen?, if this code is running, it was imported # should probably never happen?, if this code is running, it was imported
# because something was added to __path__ to match this name # because something was added to __path__ to match this name

View file

@ -3,19 +3,16 @@ Various error handling helpers
See https://beepb00p.xyz/mypy-error-handling.html#kiss for more detail See https://beepb00p.xyz/mypy-error-handling.html#kiss for more detail
""" """
from __future__ import annotations
import traceback import traceback
from collections.abc import Iterable, Iterator
from datetime import datetime from datetime import datetime
from itertools import tee from itertools import tee
from typing import ( from typing import (
Any, Any,
Callable, Callable,
Iterable,
Iterator,
List,
Literal, Literal,
Optional,
Tuple,
Type,
TypeVar, TypeVar,
Union, Union,
cast, cast,
@ -33,7 +30,7 @@ Res = ResT[T, Exception]
ErrorPolicy = Literal["yield", "raise", "drop"] ErrorPolicy = Literal["yield", "raise", "drop"]
def notnone(x: Optional[T]) -> T: def notnone(x: T | None) -> T:
assert x is not None assert x is not None
return x return x
@ -60,13 +57,15 @@ def raise_exceptions(itr: Iterable[Res[T]]) -> Iterator[T]:
yield o yield o
def warn_exceptions(itr: Iterable[Res[T]], warn_func: Optional[Callable[[Exception], None]] = None) -> Iterator[T]: def warn_exceptions(itr: Iterable[Res[T]], warn_func: Callable[[Exception], None] | None = None) -> Iterator[T]:
# if not provided, use the 'warnings' module # if not provided, use the 'warnings' module
if warn_func is None: if warn_func is None:
from my.core.warnings import medium from my.core.warnings import medium
def _warn_func(e: Exception) -> None: def _warn_func(e: Exception) -> None:
# TODO: print traceback? but user could always --raise-exceptions as well # TODO: print traceback? but user could always --raise-exceptions as well
medium(str(e)) medium(str(e))
warn_func = _warn_func warn_func = _warn_func
for o in itr: for o in itr:
@ -81,7 +80,7 @@ def echain(ex: E, cause: Exception) -> E:
return ex return ex
def split_errors(l: Iterable[ResT[T, E]], ET: Type[E]) -> Tuple[Iterable[T], Iterable[E]]: def split_errors(l: Iterable[ResT[T, E]], ET: type[E]) -> tuple[Iterable[T], Iterable[E]]:
# TODO would be nice to have ET=Exception default? but it causes some mypy complaints? # TODO would be nice to have ET=Exception default? but it causes some mypy complaints?
vit, eit = tee(l) vit, eit = tee(l)
# TODO ugh, not sure if I can reconcile type checking and runtime and convince mypy that ET and E are the same type? # TODO ugh, not sure if I can reconcile type checking and runtime and convince mypy that ET and E are the same type?
@ -99,7 +98,9 @@ def split_errors(l: Iterable[ResT[T, E]], ET: Type[E]) -> Tuple[Iterable[T], Ite
K = TypeVar('K') K = TypeVar('K')
def sort_res_by(items: Iterable[Res[T]], key: Callable[[Any], K]) -> List[Res[T]]:
def sort_res_by(items: Iterable[Res[T]], key: Callable[[Any], K]) -> list[Res[T]]:
""" """
Sort a sequence potentially interleaved with errors/entries on which the key can't be computed. Sort a sequence potentially interleaved with errors/entries on which the key can't be computed.
The general idea is: the error sticks to the non-error entry that follows it The general idea is: the error sticks to the non-error entry that follows it
@ -107,7 +108,7 @@ def sort_res_by(items: Iterable[Res[T]], key: Callable[[Any], K]) -> List[Res[T]
group = [] group = []
groups = [] groups = []
for i in items: for i in items:
k: Optional[K] k: K | None
try: try:
k = key(i) k = key(i)
except Exception: # error white computing key? dunno, might be nice to handle... except Exception: # error white computing key? dunno, might be nice to handle...
@ -117,10 +118,10 @@ def sort_res_by(items: Iterable[Res[T]], key: Callable[[Any], K]) -> List[Res[T]
groups.append((k, group)) groups.append((k, group))
group = [] group = []
results: List[Res[T]] = [] results: list[Res[T]] = []
for _v, grp in sorted(groups, key=lambda p: p[0]): # type: ignore[return-value, arg-type] # TODO SupportsLessThan?? for _v, grp in sorted(groups, key=lambda p: p[0]): # type: ignore[return-value, arg-type] # TODO SupportsLessThan??
results.extend(grp) results.extend(grp)
results.extend(group) # handle last group (it will always be errors only) results.extend(group) # handle last group (it will always be errors only)
return results return results
@ -162,20 +163,20 @@ def test_sort_res_by() -> None:
# helpers to associate timestamps with the errors (so something meaningful could be displayed on the plots, for example) # helpers to associate timestamps with the errors (so something meaningful could be displayed on the plots, for example)
# todo document it under 'patterns' somewhere... # todo document it under 'patterns' somewhere...
# todo proper typevar? # todo proper typevar?
def set_error_datetime(e: Exception, dt: Optional[datetime]) -> None: def set_error_datetime(e: Exception, dt: datetime | None) -> None:
if dt is None: if dt is None:
return return
e.args = (*e.args, dt) e.args = (*e.args, dt)
# todo not sure if should return new exception? # todo not sure if should return new exception?
def attach_dt(e: Exception, *, dt: Optional[datetime]) -> Exception: def attach_dt(e: Exception, *, dt: datetime | None) -> Exception:
set_error_datetime(e, dt) set_error_datetime(e, dt)
return e return e
# todo it might be problematic because might mess with timezones (when it's converted to string, it's converted to a shift) # todo it might be problematic because might mess with timezones (when it's converted to string, it's converted to a shift)
def extract_error_datetime(e: Exception) -> Optional[datetime]: def extract_error_datetime(e: Exception) -> datetime | None:
import re import re
for x in reversed(e.args): for x in reversed(e.args):
@ -201,10 +202,10 @@ MODULE_SETUP_URL = 'https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#p
def warn_my_config_import_error( def warn_my_config_import_error(
err: Union[ImportError, AttributeError], err: ImportError | AttributeError,
*, *,
help_url: Optional[str] = None, help_url: str | None = None,
module_name: Optional[str] = None, module_name: str | None = None,
) -> bool: ) -> bool:
""" """
If the user tried to import something from my.config but it failed, If the user tried to import something from my.config but it failed,
@ -265,7 +266,7 @@ def test_datetime_errors() -> None:
import pytz # noqa: I001 import pytz # noqa: I001
dt_notz = datetime.now() dt_notz = datetime.now()
dt_tz = datetime.now(tz=pytz.timezone('Europe/Amsterdam')) dt_tz = datetime.now(tz=pytz.timezone('Europe/Amsterdam'))
for dt in [dt_tz, dt_notz]: for dt in [dt_tz, dt_notz]:
e1 = RuntimeError('whatever') e1 = RuntimeError('whatever')
assert extract_error_datetime(e1) is None assert extract_error_datetime(e1) is None

View file

@ -1,6 +1,8 @@
from __future__ import annotations
import sys import sys
import types import types
from typing import Any, Dict, Optional from typing import Any
# The idea behind this one is to support accessing "overlaid/shadowed" modules from namespace packages # The idea behind this one is to support accessing "overlaid/shadowed" modules from namespace packages
@ -20,7 +22,7 @@ def import_original_module(
file: str, file: str,
*, *,
star: bool = False, star: bool = False,
globals: Optional[Dict[str, Any]] = None, globals: dict[str, Any] | None = None,
) -> types.ModuleType: ) -> types.ModuleType:
module_to_restore = sys.modules[module_name] module_to_restore = sys.modules[module_name]

View file

@ -1,29 +1,29 @@
from .internal import assert_subpackage; assert_subpackage(__name__) from __future__ import annotations
import dataclasses as dcl from .internal import assert_subpackage
assert_subpackage(__name__)
import dataclasses
import inspect import inspect
from typing import Any, Type, TypeVar from typing import Any, Generic, TypeVar
D = TypeVar('D') D = TypeVar('D')
def _freeze_dataclass(Orig: Type[D]): def _freeze_dataclass(Orig: type[D]):
ofields = [(f.name, f.type, f) for f in dcl.fields(Orig)] # type: ignore[arg-type] # see https://github.com/python/typing_extensions/issues/115 ofields = [(f.name, f.type, f) for f in dataclasses.fields(Orig)] # type: ignore[arg-type] # see https://github.com/python/typing_extensions/issues/115
# extract properties along with their types # extract properties along with their types
props = list(inspect.getmembers(Orig, lambda o: isinstance(o, property))) props = list(inspect.getmembers(Orig, lambda o: isinstance(o, property)))
pfields = [(name, inspect.signature(getattr(prop, 'fget')).return_annotation) for name, prop in props] pfields = [(name, inspect.signature(getattr(prop, 'fget')).return_annotation) for name, prop in props]
# FIXME not sure about name? # FIXME not sure about name?
# NOTE: sadly passing bases=[Orig] won't work, python won't let us override properties with fields # NOTE: sadly passing bases=[Orig] won't work, python won't let us override properties with fields
RRR = dcl.make_dataclass('RRR', fields=[*ofields, *pfields]) RRR = dataclasses.make_dataclass('RRR', fields=[*ofields, *pfields])
# todo maybe even declare as slots? # todo maybe even declare as slots?
return props, RRR return props, RRR
# todo need some decorator thingie?
from typing import Generic
class Freezer(Generic[D]): class Freezer(Generic[D]):
''' '''
Some magic which converts dataclass properties into fields. Some magic which converts dataclass properties into fields.
@ -31,13 +31,13 @@ class Freezer(Generic[D]):
For now only supports dataclasses. For now only supports dataclasses.
''' '''
def __init__(self, Orig: Type[D]) -> None: def __init__(self, Orig: type[D]) -> None:
self.Orig = Orig self.Orig = Orig
self.props, self.Frozen = _freeze_dataclass(Orig) self.props, self.Frozen = _freeze_dataclass(Orig)
def freeze(self, value: D) -> D: def freeze(self, value: D) -> D:
pvalues = {name: getattr(value, name) for name, _ in self.props} pvalues = {name: getattr(value, name) for name, _ in self.props}
return self.Frozen(**dcl.asdict(value), **pvalues) # type: ignore[call-overload] # see https://github.com/python/typing_extensions/issues/115 return self.Frozen(**dataclasses.asdict(value), **pvalues) # type: ignore[call-overload] # see https://github.com/python/typing_extensions/issues/115
### tests ### tests
@ -45,7 +45,7 @@ class Freezer(Generic[D]):
# this needs to be defined here to prevent a mypy bug # this needs to be defined here to prevent a mypy bug
# see https://github.com/python/mypy/issues/7281 # see https://github.com/python/mypy/issues/7281
@dcl.dataclass @dataclasses.dataclass
class _A: class _A:
x: Any x: Any
@ -71,6 +71,7 @@ def test_freezer() -> None:
assert fd['typed'] == 123 assert fd['typed'] == 123
assert fd['untyped'] == [1, 2, 3] assert fd['untyped'] == [1, 2, 3]
### ###
# TODO shit. what to do with exceptions? # TODO shit. what to do with exceptions?

View file

@ -3,11 +3,14 @@ Contains various backwards compatibility/deprecation helpers relevant to HPI its
(as opposed to .compat module which implements compatibility between python versions) (as opposed to .compat module which implements compatibility between python versions)
""" """
from __future__ import annotations
import inspect import inspect
import os import os
import re import re
from collections.abc import Iterator, Sequence
from types import ModuleType from types import ModuleType
from typing import Iterator, List, Optional, Sequence, TypeVar from typing import TypeVar
from . import warnings from . import warnings
@ -15,7 +18,7 @@ from . import warnings
def handle_legacy_import( def handle_legacy_import(
parent_module_name: str, parent_module_name: str,
legacy_submodule_name: str, legacy_submodule_name: str,
parent_module_path: List[str], parent_module_path: list[str],
) -> bool: ) -> bool:
### ###
# this is to trick mypy into treating this as a proper namespace package # this is to trick mypy into treating this as a proper namespace package
@ -122,8 +125,8 @@ class always_supports_sequence(Iterator[V]):
def __init__(self, it: Iterator[V]) -> None: def __init__(self, it: Iterator[V]) -> None:
self._it = it self._it = it
self._list: Optional[List[V]] = None self._list: list[V] | None = None
self._lit: Optional[Iterator[V]] = None self._lit: Iterator[V] | None = None
def __iter__(self) -> Iterator[V]: # noqa: PYI034 def __iter__(self) -> Iterator[V]: # noqa: PYI034
if self._list is not None: if self._list is not None:
@ -142,7 +145,7 @@ class always_supports_sequence(Iterator[V]):
return getattr(self._it, name) return getattr(self._it, name)
@property @property
def _aslist(self) -> List[V]: def _aslist(self) -> list[V]:
if self._list is None: if self._list is None:
qualname = getattr(self._it, '__qualname__', '<no qualname>') # defensive just in case qualname = getattr(self._it, '__qualname__', '<no qualname>') # defensive just in case
warnings.medium(f'Using {qualname} as list is deprecated. Migrate to iterative processing or call list() explicitly.') warnings.medium(f'Using {qualname} as list is deprecated. Migrate to iterative processing or call list() explicitly.')

View file

@ -2,9 +2,14 @@
TODO doesn't really belong to 'core' morally, but can think of moving out later TODO doesn't really belong to 'core' morally, but can think of moving out later
''' '''
from .internal import assert_subpackage; assert_subpackage(__name__) from __future__ import annotations
from typing import Any, Dict, Iterable, Optional from .internal import assert_subpackage
assert_subpackage(__name__)
from collections.abc import Iterable
from typing import Any
import click import click
@ -21,7 +26,7 @@ class config:
RESET_DEFAULT = False RESET_DEFAULT = False
def fill(it: Iterable[Any], *, measurement: str, reset: bool=RESET_DEFAULT, dt_col: str='dt') -> None: def fill(it: Iterable[Any], *, measurement: str, reset: bool = RESET_DEFAULT, dt_col: str = 'dt') -> None:
# todo infer dt column automatically, reuse in stat? # todo infer dt column automatically, reuse in stat?
# it doesn't like dots, ends up some syntax error? # it doesn't like dots, ends up some syntax error?
measurement = measurement.replace('.', '_') measurement = measurement.replace('.', '_')
@ -30,6 +35,7 @@ def fill(it: Iterable[Any], *, measurement: str, reset: bool=RESET_DEFAULT, dt_c
db = config.db db = config.db
from influxdb import InfluxDBClient # type: ignore from influxdb import InfluxDBClient # type: ignore
client = InfluxDBClient() client = InfluxDBClient()
# todo maybe create if not exists? # todo maybe create if not exists?
# client.create_database(db) # client.create_database(db)
@ -40,7 +46,7 @@ def fill(it: Iterable[Any], *, measurement: str, reset: bool=RESET_DEFAULT, dt_c
client.delete_series(database=db, measurement=measurement) client.delete_series(database=db, measurement=measurement)
# TODO need to take schema here... # TODO need to take schema here...
cache: Dict[str, bool] = {} cache: dict[str, bool] = {}
def good(f, v) -> bool: def good(f, v) -> bool:
c = cache.get(f) c = cache.get(f)
@ -59,9 +65,9 @@ def fill(it: Iterable[Any], *, measurement: str, reset: bool=RESET_DEFAULT, dt_c
def dit() -> Iterable[Json]: def dit() -> Iterable[Json]:
for i in it: for i in it:
d = asdict(i) d = asdict(i)
tags: Optional[Json] = None tags: Json | None = None
tags_ = d.get('tags') # meh... handle in a more robust manner tags_ = d.get('tags') # meh... handle in a more robust manner
if tags_ is not None and isinstance(tags_, dict): # FIXME meh. if tags_ is not None and isinstance(tags_, dict): # FIXME meh.
del d['tags'] del d['tags']
tags = tags_ tags = tags_
@ -84,6 +90,7 @@ def fill(it: Iterable[Any], *, measurement: str, reset: bool=RESET_DEFAULT, dt_c
} }
from more_itertools import chunked from more_itertools import chunked
# "The optimal batch size is 5000 lines of line protocol." # "The optimal batch size is 5000 lines of line protocol."
# some chunking is def necessary, otherwise it fails # some chunking is def necessary, otherwise it fails
inserted = 0 inserted = 0
@ -97,9 +104,9 @@ def fill(it: Iterable[Any], *, measurement: str, reset: bool=RESET_DEFAULT, dt_c
# todo "Specify timestamp precision when writing to InfluxDB."? # todo "Specify timestamp precision when writing to InfluxDB."?
def magic_fill(it, *, name: Optional[str]=None, reset: bool=RESET_DEFAULT) -> None: def magic_fill(it, *, name: str | None = None, reset: bool = RESET_DEFAULT) -> None:
if name is None: if name is None:
assert callable(it) # generators have no name/module assert callable(it) # generators have no name/module
name = f'{it.__module__}:{it.__name__}' name = f'{it.__module__}:{it.__name__}'
assert name is not None assert name is not None
@ -109,6 +116,7 @@ def magic_fill(it, *, name: Optional[str]=None, reset: bool=RESET_DEFAULT) -> No
from itertools import tee from itertools import tee
from more_itertools import first, one from more_itertools import first, one
it, x = tee(it) it, x = tee(it)
f = first(x, default=None) f = first(x, default=None)
if f is None: if f is None:
@ -118,9 +126,11 @@ def magic_fill(it, *, name: Optional[str]=None, reset: bool=RESET_DEFAULT) -> No
# TODO can we reuse pandas code or something? # TODO can we reuse pandas code or something?
# #
from .pandas import _as_columns from .pandas import _as_columns
schema = _as_columns(type(f)) schema = _as_columns(type(f))
from datetime import datetime from datetime import datetime
dtex = RuntimeError(f'expected single datetime field. schema: {schema}') dtex = RuntimeError(f'expected single datetime field. schema: {schema}')
dtf = one((f for f, t in schema.items() if t == datetime), too_short=dtex, too_long=dtex) dtf = one((f for f, t in schema.items() if t == datetime), too_short=dtex, too_long=dtex)
@ -137,6 +147,7 @@ def main() -> None:
@click.argument('FUNCTION_NAME', type=str, required=True) @click.argument('FUNCTION_NAME', type=str, required=True)
def populate(*, function_name: str, reset: bool) -> None: def populate(*, function_name: str, reset: bool) -> None:
from .__main__ import _locate_functions_or_prompt from .__main__ import _locate_functions_or_prompt
[provider] = list(_locate_functions_or_prompt([function_name])) [provider] = list(_locate_functions_or_prompt([function_name]))
# todo could have a non-interactive version which populates from all data sources for the provider? # todo could have a non-interactive version which populates from all data sources for the provider?
magic_fill(provider, reset=reset) magic_fill(provider, reset=reset)

View file

@ -19,6 +19,7 @@ def setup_config() -> None:
from pathlib import Path from pathlib import Path
from .preinit import get_mycfg_dir from .preinit import get_mycfg_dir
mycfg_dir = get_mycfg_dir() mycfg_dir = get_mycfg_dir()
if not mycfg_dir.exists(): if not mycfg_dir.exists():
@ -43,6 +44,7 @@ See https://github.com/karlicoss/HPI/blob/master/doc/SETUP.org#setting-up-the-mo
except ImportError as ex: except ImportError as ex:
# just in case... who knows what crazy setup users have # just in case... who knows what crazy setup users have
import logging import logging
logging.exception(ex) logging.exception(ex)
warnings.warn(f""" warnings.warn(f"""
Importing 'my.config' failed! (error: {ex}). This is likely to result in issues. Importing 'my.config' failed! (error: {ex}). This is likely to result in issues.

View file

@ -1,4 +1,6 @@
from .internal import assert_subpackage; assert_subpackage(__name__) from .internal import assert_subpackage
assert_subpackage(__name__)
from . import warnings from . import warnings

View file

@ -5,17 +5,21 @@ This can potentially allow both for safer defensive parsing, and let you know if
TODO perhaps need to get some inspiration from linear logic to decide on a nice API... TODO perhaps need to get some inspiration from linear logic to decide on a nice API...
''' '''
from __future__ import annotations
from collections import OrderedDict from collections import OrderedDict
from typing import Any, List from typing import Any
def ignore(w, *keys): def ignore(w, *keys):
for k in keys: for k in keys:
w[k].ignore() w[k].ignore()
def zoom(w, *keys): def zoom(w, *keys):
return [w[k].zoom() for k in keys] return [w[k].zoom() for k in keys]
# TODO need to support lists # TODO need to support lists
class Zoomable: class Zoomable:
def __init__(self, parent, *args, **kwargs) -> None: def __init__(self, parent, *args, **kwargs) -> None:
@ -40,7 +44,7 @@ class Zoomable:
assert self.parent is not None assert self.parent is not None
self.parent._remove(self) self.parent._remove(self)
def zoom(self) -> 'Zoomable': def zoom(self) -> Zoomable:
self.consume() self.consume()
return self return self
@ -63,6 +67,7 @@ class Wdict(Zoomable, OrderedDict):
def this_consumed(self): def this_consumed(self):
return len(self) == 0 return len(self) == 0
# TODO specify mypy type for the index special method? # TODO specify mypy type for the index special method?
@ -77,6 +82,7 @@ class Wlist(Zoomable, list):
def this_consumed(self): def this_consumed(self):
return len(self) == 0 return len(self) == 0
class Wvalue(Zoomable): class Wvalue(Zoomable):
def __init__(self, parent, value: Any) -> None: def __init__(self, parent, value: Any) -> None:
super().__init__(parent) super().__init__(parent)
@ -87,23 +93,20 @@ class Wvalue(Zoomable):
return [] return []
def this_consumed(self): def this_consumed(self):
return True # TODO not sure.. return True # TODO not sure..
def __repr__(self): def __repr__(self):
return 'WValue{' + repr(self.value) + '}' return 'WValue{' + repr(self.value) + '}'
from typing import Tuple def _wrap(j, parent=None) -> tuple[Zoomable, list[Zoomable]]:
def _wrap(j, parent=None) -> Tuple[Zoomable, List[Zoomable]]:
res: Zoomable res: Zoomable
cc: List[Zoomable] cc: list[Zoomable]
if isinstance(j, dict): if isinstance(j, dict):
res = Wdict(parent) res = Wdict(parent)
cc = [res] cc = [res]
for k, v in j.items(): for k, v in j.items():
vv, c = _wrap(v, parent=res) vv, c = _wrap(v, parent=res)
res[k] = vv res[k] = vv
cc.extend(c) cc.extend(c)
return res, cc return res, cc
@ -122,13 +125,14 @@ def _wrap(j, parent=None) -> Tuple[Zoomable, List[Zoomable]]:
raise RuntimeError(f'Unexpected type: {type(j)} {j}') raise RuntimeError(f'Unexpected type: {type(j)} {j}')
from collections.abc import Iterator
from contextlib import contextmanager from contextlib import contextmanager
from typing import Iterator
class UnconsumedError(Exception): class UnconsumedError(Exception):
pass pass
# TODO think about error policy later... # TODO think about error policy later...
@contextmanager @contextmanager
def wrap(j, *, throw=True) -> Iterator[Zoomable]: def wrap(j, *, throw=True) -> Iterator[Zoomable]:
@ -137,7 +141,7 @@ def wrap(j, *, throw=True) -> Iterator[Zoomable]:
yield w yield w
for c in children: for c in children:
if not c.this_consumed(): # TODO hmm. how does it figure out if it's consumed??? if not c.this_consumed(): # TODO hmm. how does it figure out if it's consumed???
if throw: if throw:
# TODO need to keep a full path or something... # TODO need to keep a full path or something...
raise UnconsumedError(f''' raise UnconsumedError(f'''
@ -153,6 +157,7 @@ from typing import cast
def test_unconsumed() -> None: def test_unconsumed() -> None:
import pytest import pytest
with pytest.raises(UnconsumedError): with pytest.raises(UnconsumedError):
with wrap({'a': 1234}) as w: with wrap({'a': 1234}) as w:
w = cast(Wdict, w) w = cast(Wdict, w)
@ -163,6 +168,7 @@ def test_unconsumed() -> None:
w = cast(Wdict, w) w = cast(Wdict, w)
d = w['c']['d'].zoom() d = w['c']['d'].zoom()
def test_consumed() -> None: def test_consumed() -> None:
with wrap({'a': 1234}) as w: with wrap({'a': 1234}) as w:
w = cast(Wdict, w) w = cast(Wdict, w)
@ -173,6 +179,7 @@ def test_consumed() -> None:
c = w['c'].zoom() c = w['c'].zoom()
d = c['d'].zoom() d = c['d'].zoom()
def test_types() -> None: def test_types() -> None:
# (string, number, object, array, boolean or nul # (string, number, object, array, boolean or nul
with wrap({'string': 'string', 'number': 3.14, 'boolean': True, 'null': None, 'list': [1, 2, 3]}) as w: with wrap({'string': 'string', 'number': 3.14, 'boolean': True, 'null': None, 'list': [1, 2, 3]}) as w:
@ -181,9 +188,10 @@ def test_types() -> None:
w['number'].consume() w['number'].consume()
w['boolean'].zoom() w['boolean'].zoom()
w['null'].zoom() w['null'].zoom()
for x in list(w['list'].zoom()): # TODO eh. how to avoid the extra list thing? for x in list(w['list'].zoom()): # TODO eh. how to avoid the extra list thing?
x.consume() x.consume()
def test_consume_all() -> None: def test_consume_all() -> None:
with wrap({'aaa': {'bbb': {'hi': 123}}}) as w: with wrap({'aaa': {'bbb': {'hi': 123}}}) as w:
w = cast(Wdict, w) w = cast(Wdict, w)
@ -193,11 +201,9 @@ def test_consume_all() -> None:
def test_consume_few() -> None: def test_consume_few() -> None:
import pytest import pytest
pytest.skip('Will think about it later..') pytest.skip('Will think about it later..')
with wrap({ with wrap({'important': 123, 'unimportant': 'whatever'}) as w:
'important': 123,
'unimportant': 'whatever'
}) as w:
w = cast(Wdict, w) w = cast(Wdict, w)
w['important'].zoom() w['important'].zoom()
w.consume_all() w.consume_all()
@ -206,6 +212,7 @@ def test_consume_few() -> None:
def test_zoom() -> None: def test_zoom() -> None:
import pytest import pytest
with wrap({'aaa': 'whatever'}) as w: with wrap({'aaa': 'whatever'}) as w:
w = cast(Wdict, w) w = cast(Wdict, w)
with pytest.raises(KeyError): with pytest.raises(KeyError):
@ -229,7 +236,7 @@ def test_zoom() -> None:
# - very flexible, easy to adjust behaviour # - very flexible, easy to adjust behaviour
# - cons: # - cons:
# - can forget to assert about extra entities etc, so error prone # - can forget to assert about extra entities etc, so error prone
# - if we do something like =assert j.pop('status') == 200, j=, by the time assert happens we already popped item -- makes erro handling harder # - if we do something like =assert j.pop('status') == 200, j=, by the time assert happens we already popped item -- makes error handling harder
# - a bit verbose.. so probably requires some helper functions though (could be much leaner than current konsume though) # - a bit verbose.. so probably requires some helper functions though (could be much leaner than current konsume though)
# - if we assert, then terminates parsing too early, if we're defensive then inflates the code a lot with if statements # - if we assert, then terminates parsing too early, if we're defensive then inflates the code a lot with if statements
# - TODO perhaps combine warnings somehow or at least only emit once per module? # - TODO perhaps combine warnings somehow or at least only emit once per module?

View file

@ -250,7 +250,7 @@ if __name__ == '__main__':
test() test()
## legacy/deprecated methods for backwards compatilibity ## legacy/deprecated methods for backwards compatibility
if not TYPE_CHECKING: if not TYPE_CHECKING:
from .compat import deprecated from .compat import deprecated

View file

@ -2,11 +2,14 @@
Utils for mime/filetype handling Utils for mime/filetype handling
""" """
from .internal import assert_subpackage; assert_subpackage(__name__) from __future__ import annotations
from .internal import assert_subpackage
assert_subpackage(__name__)
import functools import functools
from pathlib import Path
from .common import PathIsh
@functools.lru_cache(1) @functools.lru_cache(1)
@ -23,7 +26,7 @@ import mimetypes # todo do I need init()?
# todo wtf? fastermime thinks it's mime is application/json even if the extension is xz?? # todo wtf? fastermime thinks it's mime is application/json even if the extension is xz??
# whereas magic detects correctly: application/x-zstd and application/x-xz # whereas magic detects correctly: application/x-zstd and application/x-xz
def fastermime(path: PathIsh) -> str: def fastermime(path: Path | str) -> str:
paths = str(path) paths = str(path)
# mimetypes is faster, so try it first # mimetypes is faster, so try it first
(mime, _) = mimetypes.guess_type(paths) (mime, _) = mimetypes.guess_type(paths)

View file

@ -1,6 +1,7 @@
""" """
Various helpers for reading org-mode data Various helpers for reading org-mode data
""" """
from datetime import datetime from datetime import datetime
@ -22,17 +23,20 @@ def parse_org_datetime(s: str) -> datetime:
# TODO I guess want to borrow inspiration from bs4? element type <-> tag; and similar logic for find_one, find_all # TODO I guess want to borrow inspiration from bs4? element type <-> tag; and similar logic for find_one, find_all
from typing import Callable, Iterable, TypeVar from collections.abc import Iterable
from typing import Callable, TypeVar
from orgparse import OrgNode from orgparse import OrgNode
V = TypeVar('V') V = TypeVar('V')
def collect(n: OrgNode, cfun: Callable[[OrgNode], Iterable[V]]) -> Iterable[V]: def collect(n: OrgNode, cfun: Callable[[OrgNode], Iterable[V]]) -> Iterable[V]:
yield from cfun(n) yield from cfun(n)
for c in n.children: for c in n.children:
yield from collect(c, cfun) yield from collect(c, cfun)
from more_itertools import one from more_itertools import one
from orgparse.extra import Table from orgparse.extra import Table
@ -46,7 +50,7 @@ class TypedTable(Table):
tt = super().__new__(TypedTable) tt = super().__new__(TypedTable)
tt.__dict__ = orig.__dict__ tt.__dict__ = orig.__dict__
blocks = list(orig.blocks) blocks = list(orig.blocks)
header = blocks[0] # fist block is schema header = blocks[0] # fist block is schema
if len(header) == 2: if len(header) == 2:
# TODO later interpret first line as types # TODO later interpret first line as types
header = header[1:] header = header[1:]

View file

@ -7,17 +7,14 @@ from __future__ import annotations
# todo not sure if belongs to 'core'. It's certainly 'more' core than actual modules, but still not essential # todo not sure if belongs to 'core'. It's certainly 'more' core than actual modules, but still not essential
# NOTE: this file is meant to be importable without Pandas installed # NOTE: this file is meant to be importable without Pandas installed
import dataclasses import dataclasses
from collections.abc import Iterable, Iterator
from datetime import datetime, timezone from datetime import datetime, timezone
from pprint import pformat from pprint import pformat
from typing import ( from typing import (
TYPE_CHECKING, TYPE_CHECKING,
Any, Any,
Callable, Callable,
Dict,
Iterable,
Iterator,
Literal, Literal,
Type,
TypeVar, TypeVar,
) )
@ -178,7 +175,7 @@ def _to_jsons(it: Iterable[Res[Any]]) -> Iterable[Json]:
Schema = Any Schema = Any
def _as_columns(s: Schema) -> Dict[str, Type]: def _as_columns(s: Schema) -> dict[str, type]:
# todo would be nice to extract properties; add tests for this as well # todo would be nice to extract properties; add tests for this as well
if dataclasses.is_dataclass(s): if dataclasses.is_dataclass(s):
return {f.name: f.type for f in dataclasses.fields(s)} # type: ignore[misc] # ugh, why mypy thinks f.type can return str?? return {f.name: f.type for f in dataclasses.fields(s)} # type: ignore[misc] # ugh, why mypy thinks f.type can return str??

View file

@ -8,6 +8,7 @@ def get_mycfg_dir() -> Path:
import os import os
import appdirs # type: ignore[import-untyped] import appdirs # type: ignore[import-untyped]
# not sure if that's necessary, i.e. could rely on PYTHONPATH instead # not sure if that's necessary, i.e. could rely on PYTHONPATH instead
# on the other hand, by using MY_CONFIG we are guaranteed to load it from the desired path? # on the other hand, by using MY_CONFIG we are guaranteed to load it from the desired path?
mvar = os.environ.get('MY_CONFIG') mvar = os.environ.get('MY_CONFIG')

View file

@ -2,7 +2,9 @@
Helpers to prevent depending on pytest in runtime Helpers to prevent depending on pytest in runtime
""" """
from .internal import assert_subpackage; assert_subpackage(__name__) from .internal import assert_subpackage
assert_subpackage(__name__)
import sys import sys
import typing import typing

View file

@ -5,23 +5,20 @@ The main entrypoint to this library is the 'select' function below; try:
python3 -c "from my.core.query import select; help(select)" python3 -c "from my.core.query import select; help(select)"
""" """
from __future__ import annotations
import dataclasses import dataclasses
import importlib import importlib
import inspect import inspect
import itertools import itertools
from collections.abc import Iterable, Iterator
from datetime import datetime from datetime import datetime
from typing import ( from typing import (
Any, Any,
Callable, Callable,
Dict,
Iterable,
Iterator,
List,
NamedTuple, NamedTuple,
Optional, Optional,
Tuple,
TypeVar, TypeVar,
Union,
) )
import more_itertools import more_itertools
@ -51,6 +48,7 @@ class Unsortable(NamedTuple):
class QueryException(ValueError): class QueryException(ValueError):
"""Used to differentiate query-related errors, so the CLI interface is more expressive""" """Used to differentiate query-related errors, so the CLI interface is more expressive"""
pass pass
@ -63,7 +61,7 @@ def locate_function(module_name: str, function_name: str) -> Callable[[], Iterab
""" """
try: try:
mod = importlib.import_module(module_name) mod = importlib.import_module(module_name)
for (fname, f) in inspect.getmembers(mod, inspect.isfunction): for fname, f in inspect.getmembers(mod, inspect.isfunction):
if fname == function_name: if fname == function_name:
return f return f
# in case the function is defined dynamically, # in case the function is defined dynamically,
@ -83,10 +81,10 @@ def locate_qualified_function(qualified_name: str) -> Callable[[], Iterable[ET]]
if "." not in qualified_name: if "." not in qualified_name:
raise QueryException("Could not find a '.' in the function name, e.g. my.reddit.rexport.comments") raise QueryException("Could not find a '.' in the function name, e.g. my.reddit.rexport.comments")
rdot_index = qualified_name.rindex(".") rdot_index = qualified_name.rindex(".")
return locate_function(qualified_name[:rdot_index], qualified_name[rdot_index + 1:]) return locate_function(qualified_name[:rdot_index], qualified_name[rdot_index + 1 :])
def attribute_func(obj: T, where: Where, default: Optional[U] = None) -> Optional[OrderFunc]: def attribute_func(obj: T, where: Where, default: U | None = None) -> OrderFunc | None:
""" """
Attempts to find an attribute which matches the 'where_function' on the object, Attempts to find an attribute which matches the 'where_function' on the object,
using some getattr/dict checks. Returns a function which when called with using some getattr/dict checks. Returns a function which when called with
@ -133,11 +131,11 @@ def attribute_func(obj: T, where: Where, default: Optional[U] = None) -> Optiona
def _generate_order_by_func( def _generate_order_by_func(
obj_res: Res[T], obj_res: Res[T],
*, *,
key: Optional[str] = None, key: str | None = None,
where_function: Optional[Where] = None, where_function: Where | None = None,
default: Optional[U] = None, default: U | None = None,
force_unsortable: bool = False, force_unsortable: bool = False,
) -> Optional[OrderFunc]: ) -> OrderFunc | None:
""" """
Accepts an object Res[T] (Instance of some class or Exception) Accepts an object Res[T] (Instance of some class or Exception)
@ -202,7 +200,7 @@ pass 'drop_exceptions' to ignore exceptions""")
# user must provide either a key or a where predicate # user must provide either a key or a where predicate
if where_function is not None: if where_function is not None:
func: Optional[OrderFunc] = attribute_func(obj, where_function, default) func: OrderFunc | None = attribute_func(obj, where_function, default)
if func is not None: if func is not None:
return func return func
@ -218,8 +216,6 @@ pass 'drop_exceptions' to ignore exceptions""")
return None # couldn't compute a OrderFunc for this class/instance return None # couldn't compute a OrderFunc for this class/instance
# currently using the 'key set' as a proxy for 'this is the same type of thing' # currently using the 'key set' as a proxy for 'this is the same type of thing'
def _determine_order_by_value_key(obj_res: ET) -> Any: def _determine_order_by_value_key(obj_res: ET) -> Any:
""" """
@ -244,7 +240,7 @@ def _drop_unsorted(itr: Iterator[ET], orderfunc: OrderFunc) -> Iterator[ET]:
# try getting the first value from the iterator # try getting the first value from the iterator
# similar to my.core.common.warn_if_empty? this doesn't go through the whole iterator though # similar to my.core.common.warn_if_empty? this doesn't go through the whole iterator though
def _peek_iter(itr: Iterator[ET]) -> Tuple[Optional[ET], Iterator[ET]]: def _peek_iter(itr: Iterator[ET]) -> tuple[ET | None, Iterator[ET]]:
itr = more_itertools.peekable(itr) itr = more_itertools.peekable(itr)
try: try:
first_item = itr.peek() first_item = itr.peek()
@ -255,9 +251,9 @@ def _peek_iter(itr: Iterator[ET]) -> Tuple[Optional[ET], Iterator[ET]]:
# similar to 'my.core.error.sort_res_by'? # similar to 'my.core.error.sort_res_by'?
def _wrap_unsorted(itr: Iterator[ET], orderfunc: OrderFunc) -> Tuple[Iterator[Unsortable], Iterator[ET]]: def _wrap_unsorted(itr: Iterator[ET], orderfunc: OrderFunc) -> tuple[Iterator[Unsortable], Iterator[ET]]:
unsortable: List[Unsortable] = [] unsortable: list[Unsortable] = []
sortable: List[ET] = [] sortable: list[ET] = []
for o in itr: for o in itr:
# if input to select was another select # if input to select was another select
if isinstance(o, Unsortable): if isinstance(o, Unsortable):
@ -279,7 +275,7 @@ def _handle_unsorted(
orderfunc: OrderFunc, orderfunc: OrderFunc,
drop_unsorted: bool, drop_unsorted: bool,
wrap_unsorted: bool wrap_unsorted: bool
) -> Tuple[Iterator[Unsortable], Iterator[ET]]: ) -> tuple[Iterator[Unsortable], Iterator[ET]]:
# prefer drop_unsorted to wrap_unsorted, if both were present # prefer drop_unsorted to wrap_unsorted, if both were present
if drop_unsorted: if drop_unsorted:
return iter([]), _drop_unsorted(itr, orderfunc) return iter([]), _drop_unsorted(itr, orderfunc)
@ -294,16 +290,16 @@ def _handle_unsorted(
# different types. ***This consumes the iterator***, so # different types. ***This consumes the iterator***, so
# you should definitely itertoolts.tee it beforehand # you should definitely itertoolts.tee it beforehand
# as to not exhaust the values # as to not exhaust the values
def _generate_order_value_func(itr: Iterator[ET], order_value: Where, default: Optional[U] = None) -> OrderFunc: def _generate_order_value_func(itr: Iterator[ET], order_value: Where, default: U | None = None) -> OrderFunc:
# TODO: add a kwarg to force lookup for every item? would sort of be like core.common.guess_datetime then # TODO: add a kwarg to force lookup for every item? would sort of be like core.common.guess_datetime then
order_by_lookup: Dict[Any, OrderFunc] = {} order_by_lookup: dict[Any, OrderFunc] = {}
# need to go through a copy of the whole iterator here to # need to go through a copy of the whole iterator here to
# pre-generate functions to support sorting mixed types # pre-generate functions to support sorting mixed types
for obj_res in itr: for obj_res in itr:
key: Any = _determine_order_by_value_key(obj_res) key: Any = _determine_order_by_value_key(obj_res)
if key not in order_by_lookup: if key not in order_by_lookup:
keyfunc: Optional[OrderFunc] = _generate_order_by_func( keyfunc: OrderFunc | None = _generate_order_by_func(
obj_res, obj_res,
where_function=order_value, where_function=order_value,
default=default, default=default,
@ -324,12 +320,12 @@ def _generate_order_value_func(itr: Iterator[ET], order_value: Where, default: O
def _handle_generate_order_by( def _handle_generate_order_by(
itr, itr,
*, *,
order_by: Optional[OrderFunc] = None, order_by: OrderFunc | None = None,
order_key: Optional[str] = None, order_key: str | None = None,
order_value: Optional[Where] = None, order_value: Where | None = None,
default: Optional[U] = None, default: U | None = None,
) -> Tuple[Optional[OrderFunc], Iterator[ET]]: ) -> tuple[OrderFunc | None, Iterator[ET]]:
order_by_chosen: Optional[OrderFunc] = order_by # if the user just supplied a function themselves order_by_chosen: OrderFunc | None = order_by # if the user just supplied a function themselves
if order_by is not None: if order_by is not None:
return order_by, itr return order_by, itr
if order_key is not None: if order_key is not None:
@ -354,19 +350,19 @@ def _handle_generate_order_by(
def select( def select(
src: Union[Iterable[ET], Callable[[], Iterable[ET]]], src: Iterable[ET] | Callable[[], Iterable[ET]],
*, *,
where: Optional[Where] = None, where: Where | None = None,
order_by: Optional[OrderFunc] = None, order_by: OrderFunc | None = None,
order_key: Optional[str] = None, order_key: str | None = None,
order_value: Optional[Where] = None, order_value: Where | None = None,
default: Optional[U] = None, default: U | None = None,
reverse: bool = False, reverse: bool = False,
limit: Optional[int] = None, limit: int | None = None,
drop_unsorted: bool = False, drop_unsorted: bool = False,
wrap_unsorted: bool = True, wrap_unsorted: bool = True,
warn_exceptions: bool = False, warn_exceptions: bool = False,
warn_func: Optional[Callable[[Exception], None]] = None, warn_func: Callable[[Exception], None] | None = None,
drop_exceptions: bool = False, drop_exceptions: bool = False,
raise_exceptions: bool = False, raise_exceptions: bool = False,
) -> Iterator[ET]: ) -> Iterator[ET]:
@ -617,7 +613,7 @@ class _B(NamedTuple):
# move these to tests/? They are re-used so much in the tests below, # move these to tests/? They are re-used so much in the tests below,
# not sure where the best place for these is # not sure where the best place for these is
def _mixed_iter() -> Iterator[Union[_A, _B]]: def _mixed_iter() -> Iterator[_A | _B]:
yield _A(x=datetime(year=2009, month=5, day=10, hour=4, minute=10, second=1), y=5, z=10) yield _A(x=datetime(year=2009, month=5, day=10, hour=4, minute=10, second=1), y=5, z=10)
yield _B(y=datetime(year=2015, month=5, day=10, hour=4, minute=10, second=1)) yield _B(y=datetime(year=2015, month=5, day=10, hour=4, minute=10, second=1))
yield _A(x=datetime(year=2005, month=5, day=10, hour=4, minute=10, second=1), y=10, z=2) yield _A(x=datetime(year=2005, month=5, day=10, hour=4, minute=10, second=1), y=10, z=2)
@ -626,7 +622,7 @@ def _mixed_iter() -> Iterator[Union[_A, _B]]:
yield _A(x=datetime(year=2005, month=4, day=10, hour=4, minute=10, second=1), y=2, z=-5) yield _A(x=datetime(year=2005, month=4, day=10, hour=4, minute=10, second=1), y=2, z=-5)
def _mixed_iter_errors() -> Iterator[Res[Union[_A, _B]]]: def _mixed_iter_errors() -> Iterator[Res[_A | _B]]:
m = _mixed_iter() m = _mixed_iter()
yield from itertools.islice(m, 0, 3) yield from itertools.islice(m, 0, 3)
yield RuntimeError("Unhandled error!") yield RuntimeError("Unhandled error!")

View file

@ -7,11 +7,14 @@ filtered iterator
See the select_range function below See the select_range function below
""" """
from __future__ import annotations
import re import re
import time import time
from collections.abc import Iterator
from datetime import date, datetime, timedelta from datetime import date, datetime, timedelta
from functools import lru_cache from functools import cache
from typing import Any, Callable, Iterator, NamedTuple, Optional, Type from typing import Any, Callable, NamedTuple
import more_itertools import more_itertools
@ -25,7 +28,9 @@ from .query import (
select, select,
) )
timedelta_regex = re.compile(r"^((?P<weeks>[\.\d]+?)w)?((?P<days>[\.\d]+?)d)?((?P<hours>[\.\d]+?)h)?((?P<minutes>[\.\d]+?)m)?((?P<seconds>[\.\d]+?)s)?$") timedelta_regex = re.compile(
r"^((?P<weeks>[\.\d]+?)w)?((?P<days>[\.\d]+?)d)?((?P<hours>[\.\d]+?)h)?((?P<minutes>[\.\d]+?)m)?((?P<seconds>[\.\d]+?)s)?$"
)
# https://stackoverflow.com/a/51916936 # https://stackoverflow.com/a/51916936
@ -88,7 +93,7 @@ def parse_datetime_float(date_str: str) -> float:
# dateparser is a bit more lenient than the above, lets you type # dateparser is a bit more lenient than the above, lets you type
# all sorts of dates as inputs # all sorts of dates as inputs
# https://github.com/scrapinghub/dateparser#how-to-use # https://github.com/scrapinghub/dateparser#how-to-use
res: Optional[datetime] = dateparser.parse(ds, settings={"DATE_ORDER": "YMD"}) res: datetime | None = dateparser.parse(ds, settings={"DATE_ORDER": "YMD"})
if res is not None: if res is not None:
return res.timestamp() return res.timestamp()
@ -98,7 +103,7 @@ def parse_datetime_float(date_str: str) -> float:
# probably DateLike input? but a user could specify an order_key # probably DateLike input? but a user could specify an order_key
# which is an epoch timestamp or a float value which they # which is an epoch timestamp or a float value which they
# expect to be converted to a datetime to compare # expect to be converted to a datetime to compare
@lru_cache(maxsize=None) @cache
def _datelike_to_float(dl: Any) -> float: def _datelike_to_float(dl: Any) -> float:
if isinstance(dl, datetime): if isinstance(dl, datetime):
return dl.timestamp() return dl.timestamp()
@ -130,11 +135,12 @@ class RangeTuple(NamedTuple):
of the timeframe -- 'before' of the timeframe -- 'before'
- before and after - anything after 'after' and before 'before', acts as a time range - before and after - anything after 'after' and before 'before', acts as a time range
""" """
# technically doesn't need to be Optional[Any], # technically doesn't need to be Optional[Any],
# just to make it more clear these can be None # just to make it more clear these can be None
after: Optional[Any] after: Any | None
before: Optional[Any] before: Any | None
within: Optional[Any] within: Any | None
Converter = Callable[[Any], Any] Converter = Callable[[Any], Any]
@ -145,9 +151,9 @@ def _parse_range(
unparsed_range: RangeTuple, unparsed_range: RangeTuple,
end_parser: Converter, end_parser: Converter,
within_parser: Converter, within_parser: Converter,
parsed_range: Optional[RangeTuple] = None, parsed_range: RangeTuple | None = None,
error_message: Optional[str] = None error_message: str | None = None,
) -> Optional[RangeTuple]: ) -> RangeTuple | None:
if parsed_range is not None: if parsed_range is not None:
return parsed_range return parsed_range
@ -176,11 +182,11 @@ def _create_range_filter(
end_parser: Converter, end_parser: Converter,
within_parser: Converter, within_parser: Converter,
attr_func: Where, attr_func: Where,
parsed_range: Optional[RangeTuple] = None, parsed_range: RangeTuple | None = None,
default_before: Optional[Any] = None, default_before: Any | None = None,
value_coercion_func: Optional[Converter] = None, value_coercion_func: Converter | None = None,
error_message: Optional[str] = None, error_message: str | None = None,
) -> Optional[Where]: ) -> Where | None:
""" """
Handles: Handles:
- parsing the user input into values that are comparable to items the iterable returns - parsing the user input into values that are comparable to items the iterable returns
@ -272,17 +278,17 @@ def _create_range_filter(
def select_range( def select_range(
itr: Iterator[ET], itr: Iterator[ET],
*, *,
where: Optional[Where] = None, where: Where | None = None,
order_key: Optional[str] = None, order_key: str | None = None,
order_value: Optional[Where] = None, order_value: Where | None = None,
order_by_value_type: Optional[Type] = None, order_by_value_type: type | None = None,
unparsed_range: Optional[RangeTuple] = None, unparsed_range: RangeTuple | None = None,
reverse: bool = False, reverse: bool = False,
limit: Optional[int] = None, limit: int | None = None,
drop_unsorted: bool = False, drop_unsorted: bool = False,
wrap_unsorted: bool = False, wrap_unsorted: bool = False,
warn_exceptions: bool = False, warn_exceptions: bool = False,
warn_func: Optional[Callable[[Exception], None]] = None, warn_func: Callable[[Exception], None] | None = None,
drop_exceptions: bool = False, drop_exceptions: bool = False,
raise_exceptions: bool = False, raise_exceptions: bool = False,
) -> Iterator[ET]: ) -> Iterator[ET]:
@ -317,9 +323,10 @@ def select_range(
drop_exceptions=drop_exceptions, drop_exceptions=drop_exceptions,
raise_exceptions=raise_exceptions, raise_exceptions=raise_exceptions,
warn_exceptions=warn_exceptions, warn_exceptions=warn_exceptions,
warn_func=warn_func) warn_func=warn_func,
)
order_by_chosen: Optional[OrderFunc] = None order_by_chosen: OrderFunc | None = None
# if the user didn't specify an attribute to order value, but specified a type # if the user didn't specify an attribute to order value, but specified a type
# we should search for on each value in the iterator # we should search for on each value in the iterator
@ -330,6 +337,8 @@ def select_range(
# if the user supplied a order_key, and/or we've generated an order_value, create # if the user supplied a order_key, and/or we've generated an order_value, create
# the function that accesses that type on each value in the iterator # the function that accesses that type on each value in the iterator
if order_key is not None or order_value is not None: if order_key is not None or order_value is not None:
# _generate_order_value_func internally here creates a copy of the iterator, which has to
# be consumed in-case we're sorting by mixed types
order_by_chosen, itr = _handle_generate_order_by(itr, order_key=order_key, order_value=order_value) order_by_chosen, itr = _handle_generate_order_by(itr, order_key=order_key, order_value=order_value)
# signifies that itr is empty -- can early return here # signifies that itr is empty -- can early return here
if order_by_chosen is None: if order_by_chosen is None:
@ -345,7 +354,7 @@ Specify a type or a key to order the value by""")
# force drop_unsorted=True so we can use _create_range_filter # force drop_unsorted=True so we can use _create_range_filter
# sort the iterable by the generated order_by_chosen function # sort the iterable by the generated order_by_chosen function
itr = select(itr, order_by=order_by_chosen, drop_unsorted=True) itr = select(itr, order_by=order_by_chosen, drop_unsorted=True)
filter_func: Optional[Where] filter_func: Where | None
if order_by_value_type in [datetime, date]: if order_by_value_type in [datetime, date]:
filter_func = _create_range_filter( filter_func = _create_range_filter(
unparsed_range=unparsed_range, unparsed_range=unparsed_range,
@ -353,7 +362,8 @@ Specify a type or a key to order the value by""")
within_parser=parse_timedelta_float, within_parser=parse_timedelta_float,
attr_func=order_by_chosen, # type: ignore[arg-type] attr_func=order_by_chosen, # type: ignore[arg-type]
default_before=time.time(), default_before=time.time(),
value_coercion_func=_datelike_to_float) value_coercion_func=_datelike_to_float,
)
elif order_by_value_type in [int, float]: elif order_by_value_type in [int, float]:
# allow primitives to be converted using the default int(), float() callables # allow primitives to be converted using the default int(), float() callables
filter_func = _create_range_filter( filter_func = _create_range_filter(
@ -362,7 +372,8 @@ Specify a type or a key to order the value by""")
within_parser=order_by_value_type, within_parser=order_by_value_type,
attr_func=order_by_chosen, # type: ignore[arg-type] attr_func=order_by_chosen, # type: ignore[arg-type]
default_before=None, default_before=None,
value_coercion_func=order_by_value_type) value_coercion_func=order_by_value_type,
)
else: else:
# TODO: add additional kwargs to let the user sort by other values, by specifying the parsers? # TODO: add additional kwargs to let the user sort by other values, by specifying the parsers?
# would need to allow passing the end_parser, within parser, default before and value_coercion_func... # would need to allow passing the end_parser, within parser, default before and value_coercion_func...
@ -389,7 +400,7 @@ Specify a type or a key to order the value by""")
return itr return itr
# re-use items from query for testing # reuse items from query for testing
from .query import _A, _B, _Float, _mixed_iter_errors from .query import _A, _B, _Float, _mixed_iter_errors
@ -470,7 +481,7 @@ def test_range_predicate() -> None:
# filter from 0 to 5 # filter from 0 to 5
rn: RangeTuple = RangeTuple("0", "5", None) rn: RangeTuple = RangeTuple("0", "5", None)
zero_to_five_filter: Optional[Where] = int_filter_func(unparsed_range=rn) zero_to_five_filter: Where | None = int_filter_func(unparsed_range=rn)
assert zero_to_five_filter is not None assert zero_to_five_filter is not None
# this is just a Where function, given some input it return True/False if the value is allowed # this is just a Where function, given some input it return True/False if the value is allowed
assert zero_to_five_filter(3) is True assert zero_to_five_filter(3) is True
@ -483,6 +494,7 @@ def test_range_predicate() -> None:
rn = RangeTuple(None, 3, "3.5") rn = RangeTuple(None, 3, "3.5")
assert list(filter(int_filter_func(unparsed_range=rn, attr_func=identity), src())) == ["0", "1", "2"] assert list(filter(int_filter_func(unparsed_range=rn, attr_func=identity), src())) == ["0", "1", "2"]
def test_parse_range() -> None: def test_parse_range() -> None:
from functools import partial from functools import partial

View file

@ -1,9 +1,11 @@
from __future__ import annotations
import datetime import datetime
from dataclasses import asdict, is_dataclass from dataclasses import asdict, is_dataclass
from decimal import Decimal from decimal import Decimal
from functools import lru_cache from functools import cache
from pathlib import Path from pathlib import Path
from typing import Any, Callable, NamedTuple, Optional from typing import Any, Callable, NamedTuple
from .error import error_to_json from .error import error_to_json
from .pytest import parametrize from .pytest import parametrize
@ -57,12 +59,12 @@ def _default_encode(obj: Any) -> Any:
# could possibly run multiple times/raise warning if you provide different 'default' # could possibly run multiple times/raise warning if you provide different 'default'
# functions or change the kwargs? The alternative is to maintain all of this at the module # functions or change the kwargs? The alternative is to maintain all of this at the module
# level, which is just as annoying # level, which is just as annoying
@lru_cache(maxsize=None) @cache
def _dumps_factory(**kwargs) -> Callable[[Any], str]: def _dumps_factory(**kwargs) -> Callable[[Any], str]:
use_default: DefaultEncoder = _default_encode use_default: DefaultEncoder = _default_encode
# if the user passed an additional 'default' parameter, # if the user passed an additional 'default' parameter,
# try using that to serialize before before _default_encode # try using that to serialize before before _default_encode
_additional_default: Optional[DefaultEncoder] = kwargs.get("default") _additional_default: DefaultEncoder | None = kwargs.get("default")
if _additional_default is not None and callable(_additional_default): if _additional_default is not None and callable(_additional_default):
def wrapped_default(obj: Any) -> Any: def wrapped_default(obj: Any) -> Any:
@ -78,9 +80,9 @@ def _dumps_factory(**kwargs) -> Callable[[Any], str]:
kwargs["default"] = use_default kwargs["default"] = use_default
prefer_factory: Optional[str] = kwargs.pop('_prefer_factory', None) prefer_factory: str | None = kwargs.pop('_prefer_factory', None)
def orjson_factory() -> Optional[Dumps]: def orjson_factory() -> Dumps | None:
try: try:
import orjson import orjson
except ModuleNotFoundError: except ModuleNotFoundError:
@ -95,7 +97,7 @@ def _dumps_factory(**kwargs) -> Callable[[Any], str]:
return _orjson_dumps return _orjson_dumps
def simplejson_factory() -> Optional[Dumps]: def simplejson_factory() -> Dumps | None:
try: try:
from simplejson import dumps as simplejson_dumps from simplejson import dumps as simplejson_dumps
except ModuleNotFoundError: except ModuleNotFoundError:
@ -115,7 +117,7 @@ def _dumps_factory(**kwargs) -> Callable[[Any], str]:
return _simplejson_dumps return _simplejson_dumps
def stdlib_factory() -> Optional[Dumps]: def stdlib_factory() -> Dumps | None:
import json import json
from .warnings import high from .warnings import high
@ -150,7 +152,7 @@ def _dumps_factory(**kwargs) -> Callable[[Any], str]:
def dumps( def dumps(
obj: Any, obj: Any,
default: Optional[DefaultEncoder] = None, default: DefaultEncoder | None = None,
**kwargs, **kwargs,
) -> str: ) -> str:
""" """

View file

@ -3,9 +3,12 @@ Decorator to gracefully handle importing a data source, or warning
and yielding nothing (or a default) when its not available and yielding nothing (or a default) when its not available
""" """
from __future__ import annotations
import warnings import warnings
from collections.abc import Iterable, Iterator
from functools import wraps from functools import wraps
from typing import Any, Callable, Iterable, Iterator, Optional, TypeVar from typing import Any, Callable, TypeVar
from .warnings import medium from .warnings import medium
@ -26,8 +29,8 @@ _DEFAULT_ITR = ()
def import_source( def import_source(
*, *,
default: Iterable[T] = _DEFAULT_ITR, default: Iterable[T] = _DEFAULT_ITR,
module_name: Optional[str] = None, module_name: str | None = None,
help_url: Optional[str] = None, help_url: str | None = None,
) -> Callable[..., Callable[..., Iterator[T]]]: ) -> Callable[..., Callable[..., Iterator[T]]]:
""" """
doesn't really play well with types, but is used to catch doesn't really play well with types, but is used to catch
@ -50,6 +53,7 @@ def import_source(
except (ImportError, AttributeError) as err: except (ImportError, AttributeError) as err:
from . import core_config as CC from . import core_config as CC
from .error import warn_my_config_import_error from .error import warn_my_config_import_error
suppressed_in_conf = False suppressed_in_conf = False
if module_name is not None and CC.config._is_module_active(module_name) is False: if module_name is not None and CC.config._is_module_active(module_name) is False:
suppressed_in_conf = True suppressed_in_conf = True
@ -72,5 +76,7 @@ class core:
if not matched_config_err and isinstance(err, AttributeError): if not matched_config_err and isinstance(err, AttributeError):
raise err raise err
yield from default yield from default
return wrapper return wrapper
return decorator return decorator

View file

@ -1,12 +1,16 @@
from .internal import assert_subpackage; assert_subpackage(__name__) from __future__ import annotations
from .internal import assert_subpackage # noqa: I001
assert_subpackage(__name__)
import shutil import shutil
import sqlite3 import sqlite3
from collections.abc import Iterator
from contextlib import contextmanager from contextlib import contextmanager
from pathlib import Path from pathlib import Path
from tempfile import TemporaryDirectory from tempfile import TemporaryDirectory
from typing import Any, Callable, Iterator, Literal, Optional, Tuple, Union, overload from typing import Any, Callable, Literal, Union, overload
from .common import PathIsh from .common import PathIsh
from .compat import assert_never from .compat import assert_never
@ -22,6 +26,7 @@ def test_sqlite_connect_immutable(tmp_path: Path) -> None:
conn.execute('CREATE TABLE testtable (col)') conn.execute('CREATE TABLE testtable (col)')
import pytest import pytest
with pytest.raises(sqlite3.OperationalError, match='readonly database'): with pytest.raises(sqlite3.OperationalError, match='readonly database'):
with sqlite_connect_immutable(db) as conn: with sqlite_connect_immutable(db) as conn:
conn.execute('DROP TABLE testtable') conn.execute('DROP TABLE testtable')
@ -33,6 +38,7 @@ def test_sqlite_connect_immutable(tmp_path: Path) -> None:
SqliteRowFactory = Callable[[sqlite3.Cursor, sqlite3.Row], Any] SqliteRowFactory = Callable[[sqlite3.Cursor, sqlite3.Row], Any]
def dict_factory(cursor, row): def dict_factory(cursor, row):
fields = [column[0] for column in cursor.description] fields = [column[0] for column in cursor.description]
return dict(zip(fields, row)) return dict(zip(fields, row))
@ -40,8 +46,9 @@ def dict_factory(cursor, row):
Factory = Union[SqliteRowFactory, Literal['row', 'dict']] Factory = Union[SqliteRowFactory, Literal['row', 'dict']]
@contextmanager @contextmanager
def sqlite_connection(db: PathIsh, *, immutable: bool=False, row_factory: Optional[Factory]=None) -> Iterator[sqlite3.Connection]: def sqlite_connection(db: PathIsh, *, immutable: bool = False, row_factory: Factory | None = None) -> Iterator[sqlite3.Connection]:
dbp = f'file:{db}' dbp = f'file:{db}'
# https://www.sqlite.org/draft/uri.html#uriimmutable # https://www.sqlite.org/draft/uri.html#uriimmutable
if immutable: if immutable:
@ -97,31 +104,76 @@ def sqlite_copy_and_open(db: PathIsh) -> sqlite3.Connection:
# and then the return type ends up as Iterator[Tuple[str, ...]], which isn't desirable :( # and then the return type ends up as Iterator[Tuple[str, ...]], which isn't desirable :(
# a bit annoying to have this copy-pasting, but hopefully not a big issue # a bit annoying to have this copy-pasting, but hopefully not a big issue
# fmt: off
@overload @overload
def select(cols: Tuple[str ], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str ], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any ]]: ... Iterator[tuple[Any ]]: ...
@overload @overload
def select(cols: Tuple[str, str ], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str, str ], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any, Any ]]: ... Iterator[tuple[Any, Any ]]: ...
@overload @overload
def select(cols: Tuple[str, str, str ], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str, str, str ], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any, Any, Any ]]: ... Iterator[tuple[Any, Any, Any ]]: ...
@overload @overload
def select(cols: Tuple[str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any, Any, Any, Any ]]: ... Iterator[tuple[Any, Any, Any, Any ]]: ...
@overload @overload
def select(cols: Tuple[str, str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str, str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any, Any, Any, Any, Any ]]: ... Iterator[tuple[Any, Any, Any, Any, Any ]]: ...
@overload @overload
def select(cols: Tuple[str, str, str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str, str, str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any, Any, Any, Any, Any, Any ]]: ... Iterator[tuple[Any, Any, Any, Any, Any, Any ]]: ...
@overload @overload
def select(cols: Tuple[str, str, str, str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str, str, str, str, str, str, str ], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any, Any, Any, Any, Any, Any, Any ]]: ... Iterator[tuple[Any, Any, Any, Any, Any, Any, Any ]]: ...
@overload @overload
def select(cols: Tuple[str, str, str, str, str, str, str, str], rest: str, *, db: sqlite3.Connection) -> \ def select(cols: tuple[str, str, str, str, str, str, str, str], rest: str, *, db: sqlite3.Connection) -> \
Iterator[Tuple[Any, Any, Any, Any, Any, Any, Any, Any]]: ... Iterator[tuple[Any, Any, Any, Any, Any, Any, Any, Any]]: ...
# fmt: on
def select(cols, rest, *, db): def select(cols, rest, *, db):
# db arg is last cause that results in nicer code formatting.. # db arg is last cause that results in nicer code formatting..
return db.execute('SELECT ' + ','.join(cols) + ' ' + rest) return db.execute('SELECT ' + ','.join(cols) + ' ' + rest)
class SqliteTool:
def __init__(self, connection: sqlite3.Connection) -> None:
self.connection = connection
def _get_sqlite_master(self) -> dict[str, str]:
res = {}
for c in self.connection.execute('SELECT name, type FROM sqlite_master'):
[name, type_] = c
assert type_ in {'table', 'index', 'view', 'trigger'}, (name, type_) # just in case
res[name] = type_
return res
def get_table_names(self) -> list[str]:
master = self._get_sqlite_master()
res = []
for name, type_ in master.items():
if type_ != 'table':
continue
res.append(name)
return res
def get_table_schema(self, name: str) -> dict[str, str]:
"""
Returns map from column name to column type
NOTE: Sometimes this doesn't work if the db has some extensions (e.g. happens for facebook apps)
In this case you might still be able to use get_table_names
"""
schema: dict[str, str] = {}
for row in self.connection.execute(f'PRAGMA table_info(`{name}`)'):
col = row[1]
type_ = row[2]
# hmm, somewhere between 3.34.1 and 3.37.2, sqlite started normalising type names to uppercase
# let's do this just in case since python < 3.10 are using the old version
# e.g. it could have returned 'blob' and that would confuse blob check (see _check_allowed_blobs)
type_ = type_.upper()
schema[col] = type_
return schema
def get_table_schemas(self) -> dict[str, dict[str, str]]:
return {name: self.get_table_schema(name) for name in self.get_table_names()}

View file

@ -2,10 +2,13 @@
Helpers for hpi doctor/stats functionality. Helpers for hpi doctor/stats functionality.
''' '''
from __future__ import annotations
import collections.abc import collections.abc
import importlib import importlib
import inspect import inspect
import typing import typing
from collections.abc import Iterable, Iterator, Sequence
from contextlib import contextmanager from contextlib import contextmanager
from datetime import datetime from datetime import datetime
from pathlib import Path from pathlib import Path
@ -13,20 +16,13 @@ from types import ModuleType
from typing import ( from typing import (
Any, Any,
Callable, Callable,
Dict,
Iterable,
Iterator,
List,
Optional,
Protocol, Protocol,
Sequence,
Union,
cast, cast,
) )
from .types import asdict from .types import asdict
Stats = Dict[str, Any] Stats = dict[str, Any]
class StatsFun(Protocol): class StatsFun(Protocol):
@ -55,10 +51,10 @@ def quick_stats():
def stat( def stat(
func: Union[Callable[[], Iterable[Any]], Iterable[Any]], func: Callable[[], Iterable[Any]] | Iterable[Any],
*, *,
quick: bool = False, quick: bool = False,
name: Optional[str] = None, name: str | None = None,
) -> Stats: ) -> Stats:
""" """
Extracts various statistics from a passed iterable/callable, e.g.: Extracts various statistics from a passed iterable/callable, e.g.:
@ -153,8 +149,8 @@ def test_stat() -> None:
# #
def get_stats(module_name: str, *, guess: bool = False) -> Optional[StatsFun]: def get_stats(module_name: str, *, guess: bool = False) -> StatsFun | None:
stats: Optional[StatsFun] = None stats: StatsFun | None = None
try: try:
module = importlib.import_module(module_name) module = importlib.import_module(module_name)
except Exception: except Exception:
@ -167,7 +163,7 @@ def get_stats(module_name: str, *, guess: bool = False) -> Optional[StatsFun]:
# TODO maybe could be enough to annotate OUTPUTS or something like that? # TODO maybe could be enough to annotate OUTPUTS or something like that?
# then stats could just use them as hints? # then stats could just use them as hints?
def guess_stats(module: ModuleType) -> Optional[StatsFun]: def guess_stats(module: ModuleType) -> StatsFun | None:
""" """
If the module doesn't have explicitly defined 'stat' function, If the module doesn't have explicitly defined 'stat' function,
this is used to try to guess what could be included in stats automatically this is used to try to guess what could be included in stats automatically
@ -206,7 +202,7 @@ def test_guess_stats() -> None:
} }
def _guess_data_providers(module: ModuleType) -> Dict[str, Callable]: def _guess_data_providers(module: ModuleType) -> dict[str, Callable]:
mfunctions = inspect.getmembers(module, inspect.isfunction) mfunctions = inspect.getmembers(module, inspect.isfunction)
return {k: v for k, v in mfunctions if is_data_provider(v)} return {k: v for k, v in mfunctions if is_data_provider(v)}
@ -263,7 +259,7 @@ def test_is_data_provider() -> None:
lam = lambda: [1, 2] lam = lambda: [1, 2]
assert not idp(lam) assert not idp(lam)
def has_extra_args(count) -> List[int]: def has_extra_args(count) -> list[int]:
return list(range(count)) return list(range(count))
assert not idp(has_extra_args) assert not idp(has_extra_args)
@ -340,10 +336,10 @@ def test_type_is_iterable() -> None:
assert not fun(None) assert not fun(None)
assert not fun(int) assert not fun(int)
assert not fun(Any) assert not fun(Any)
assert not fun(Dict[int, int]) assert not fun(dict[int, int])
assert fun(List[int]) assert fun(list[int])
assert fun(Sequence[Dict[str, str]]) assert fun(Sequence[dict[str, str]])
assert fun(Iterable[Any]) assert fun(Iterable[Any])
@ -434,7 +430,7 @@ def test_stat_iterable() -> None:
# experimental, not sure about it.. # experimental, not sure about it..
def _guess_datetime(x: Any) -> Optional[datetime]: def _guess_datetime(x: Any) -> datetime | None:
# todo hmm implement without exception.. # todo hmm implement without exception..
try: try:
d = asdict(x) d = asdict(x)

View file

@ -1,3 +1,5 @@
from __future__ import annotations
import atexit import atexit
import os import os
import shutil import shutil
@ -5,9 +7,9 @@ import sys
import tarfile import tarfile
import tempfile import tempfile
import zipfile import zipfile
from collections.abc import Generator, Sequence
from contextlib import contextmanager from contextlib import contextmanager
from pathlib import Path from pathlib import Path
from typing import Generator, List, Sequence, Tuple, Union
from .logging import make_logger from .logging import make_logger
@ -42,10 +44,10 @@ TARGZ_EXT = {".tar.gz"}
@contextmanager @contextmanager
def match_structure( def match_structure(
base: Path, base: Path,
expected: Union[str, Sequence[str]], expected: str | Sequence[str],
*, *,
partial: bool = False, partial: bool = False,
) -> Generator[Tuple[Path, ...], None, None]: ) -> Generator[tuple[Path, ...], None, None]:
""" """
Given a 'base' directory or archive (zip/tar.gz), recursively search for one or more paths that match the Given a 'base' directory or archive (zip/tar.gz), recursively search for one or more paths that match the
pattern described in 'expected'. That can be a single string, or a list pattern described in 'expected'. That can be a single string, or a list
@ -140,8 +142,8 @@ def match_structure(
if not searchdir.is_dir(): if not searchdir.is_dir():
raise NotADirectoryError(f"Expected either a zip/tar.gz archive or a directory, received {searchdir}") raise NotADirectoryError(f"Expected either a zip/tar.gz archive or a directory, received {searchdir}")
matches: List[Path] = [] matches: list[Path] = []
possible_targets: List[Path] = [searchdir] possible_targets: list[Path] = [searchdir]
while len(possible_targets) > 0: while len(possible_targets) > 0:
p = possible_targets.pop(0) p = possible_targets.pop(0)
@ -172,7 +174,7 @@ def warn_leftover_files() -> None:
from . import core_config as CC from . import core_config as CC
base_tmp: Path = CC.config.get_tmp_dir() base_tmp: Path = CC.config.get_tmp_dir()
leftover: List[Path] = list(base_tmp.iterdir()) leftover: list[Path] = list(base_tmp.iterdir())
if leftover: if leftover:
logger.debug(f"at exit warning: Found leftover files in temporary directory '{leftover}'. this may be because you have multiple hpi processes running -- if so this can be ignored") logger.debug(f"at exit warning: Found leftover files in temporary directory '{leftover}'. this may be because you have multiple hpi processes running -- if so this can be ignored")

View file

@ -2,11 +2,11 @@
Helper 'module' for test_guess_stats Helper 'module' for test_guess_stats
""" """
from collections.abc import Iterable, Iterator, Sequence
from contextlib import contextmanager from contextlib import contextmanager
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timedelta from datetime import datetime, timedelta
from pathlib import Path from pathlib import Path
from typing import Iterable, Iterator, Sequence
@dataclass @dataclass

View file

@ -1,6 +1,8 @@
from __future__ import annotations
import os import os
from collections.abc import Iterator
from contextlib import contextmanager from contextlib import contextmanager
from typing import Iterator, Optional
import pytest import pytest
@ -15,7 +17,7 @@ skip_if_uses_optional_deps = pytest.mark.skipif(
# TODO maybe move to hpi core? # TODO maybe move to hpi core?
@contextmanager @contextmanager
def tmp_environ_set(key: str, value: Optional[str]) -> Iterator[None]: def tmp_environ_set(key: str, value: str | None) -> Iterator[None]:
prev_value = os.environ.get(key) prev_value = os.environ.get(key)
if value is None: if value is None:
os.environ.pop(key, None) os.environ.pop(key, None)

View file

@ -1,8 +1,9 @@
import json import json
import warnings import warnings
from collections.abc import Iterator
from datetime import datetime from datetime import datetime
from pathlib import Path from pathlib import Path
from typing import Iterator, NamedTuple from typing import NamedTuple
from ..denylist import DenyList from ..denylist import DenyList

View file

@ -1,6 +1,6 @@
from .common import skip_if_uses_optional_deps as pytestmark from __future__ import annotations
from typing import List from .common import skip_if_uses_optional_deps as pytestmark
# TODO ugh, this is very messy.. need to sort out config overriding here # TODO ugh, this is very messy.. need to sort out config overriding here
@ -16,7 +16,7 @@ def test_cachew() -> None:
# TODO ugh. need doublewrap or something to avoid having to pass parens # TODO ugh. need doublewrap or something to avoid having to pass parens
@mcachew() @mcachew()
def cf() -> List[int]: def cf() -> list[int]:
nonlocal called nonlocal called
called += 1 called += 1
return [1, 2, 3] return [1, 2, 3]
@ -43,7 +43,7 @@ def test_cachew_dir_none() -> None:
called = 0 called = 0
@mcachew(cache_path=cache_dir() / 'ctest') @mcachew(cache_path=cache_dir() / 'ctest')
def cf() -> List[int]: def cf() -> list[int]:
nonlocal called nonlocal called
called += 1 called += 1
return [called, called, called] return [called, called, called]

View file

@ -2,8 +2,8 @@
Various tests that are checking behaviour of user config wrt to various things Various tests that are checking behaviour of user config wrt to various things
""" """
import sys
import os import os
import sys
from pathlib import Path from pathlib import Path
import pytest import pytest

View file

@ -12,7 +12,7 @@ def _init_default_config() -> None:
def test_tmp_config() -> None: def test_tmp_config() -> None:
## ugh. ideally this would be on the top level (would be a better test) ## ugh. ideally this would be on the top level (would be a better test)
## but pytest imports eveything first, executes hooks, and some reset_modules() fictures mess stuff up ## but pytest imports everything first, executes hooks, and some reset_modules() fictures mess stuff up
## later would be nice to be a bit more careful about them ## later would be nice to be a bit more careful about them
_init_default_config() _init_default_config()
from my.simple import items from my.simple import items

View file

@ -1,5 +1,7 @@
from functools import lru_cache from __future__ import annotations
from typing import Dict, Sequence
from collections.abc import Sequence
from functools import cache, lru_cache
import pytz import pytz
@ -11,6 +13,7 @@ def user_forced() -> Sequence[str]:
# https://stackoverflow.com/questions/36067621/python-all-possible-timezone-abbreviations-for-given-timezone-name-and-vise-ve # https://stackoverflow.com/questions/36067621/python-all-possible-timezone-abbreviations-for-given-timezone-name-and-vise-ve
try: try:
from my.config import time as user_config from my.config import time as user_config
return user_config.tz.force_abbreviations # type: ignore[attr-defined] # noqa: TRY300 return user_config.tz.force_abbreviations # type: ignore[attr-defined] # noqa: TRY300
# note: noqa since we're catching case where config doesn't have attribute here as well # note: noqa since we're catching case where config doesn't have attribute here as well
except: except:
@ -19,15 +22,15 @@ def user_forced() -> Sequence[str]:
@lru_cache(1) @lru_cache(1)
def _abbr_to_timezone_map() -> Dict[str, pytz.BaseTzInfo]: def _abbr_to_timezone_map() -> dict[str, pytz.BaseTzInfo]:
# also force UTC to always correspond to utc # also force UTC to always correspond to utc
# this makes more sense than Zulu it ends up by default # this makes more sense than Zulu it ends up by default
timezones = [*pytz.all_timezones, 'UTC', *user_forced()] timezones = [*pytz.all_timezones, 'UTC', *user_forced()]
res: Dict[str, pytz.BaseTzInfo] = {} res: dict[str, pytz.BaseTzInfo] = {}
for tzname in timezones: for tzname in timezones:
tz = pytz.timezone(tzname) tz = pytz.timezone(tzname)
infos = getattr(tz, '_tzinfos', []) # not sure if can rely on attr always present? infos = getattr(tz, '_tzinfos', []) # not sure if can rely on attr always present?
for info in infos: for info in infos:
abbr = info[-1] abbr = info[-1]
# todo could support this with a better error handling strategy? # todo could support this with a better error handling strategy?
@ -43,7 +46,7 @@ def _abbr_to_timezone_map() -> Dict[str, pytz.BaseTzInfo]:
return res return res
@lru_cache(maxsize=None) @cache
def abbr_to_timezone(abbr: str) -> pytz.BaseTzInfo: def abbr_to_timezone(abbr: str) -> pytz.BaseTzInfo:
return _abbr_to_timezone_map()[abbr] return _abbr_to_timezone_map()[abbr]

View file

@ -1,14 +1,15 @@
from .internal import assert_subpackage; assert_subpackage(__name__) from __future__ import annotations
from .internal import assert_subpackage
assert_subpackage(__name__)
from dataclasses import asdict as dataclasses_asdict from dataclasses import asdict as dataclasses_asdict
from dataclasses import is_dataclass from dataclasses import is_dataclass
from datetime import datetime from datetime import datetime
from typing import ( from typing import Any
Any,
Dict,
)
Json = Dict[str, Any] Json = dict[str, Any]
# for now just serves documentation purposes... but one day might make it statically verifiable where possible? # for now just serves documentation purposes... but one day might make it statically verifiable where possible?

View file

@ -1,10 +1,12 @@
from __future__ import annotations
import os import os
import pkgutil import pkgutil
import sys import sys
from collections.abc import Iterable
from itertools import chain from itertools import chain
from pathlib import Path from pathlib import Path
from types import ModuleType from types import ModuleType
from typing import Iterable, List, Optional
from .discovery_pure import HPIModule, _is_not_module_src, has_stats, ignored from .discovery_pure import HPIModule, _is_not_module_src, has_stats, ignored
@ -20,13 +22,14 @@ from .discovery_pure import NOT_HPI_MODULE_VAR
assert NOT_HPI_MODULE_VAR in globals() # check name consistency assert NOT_HPI_MODULE_VAR in globals() # check name consistency
def is_not_hpi_module(module: str) -> Optional[str]:
def is_not_hpi_module(module: str) -> str | None:
''' '''
None if a module, otherwise returns reason None if a module, otherwise returns reason
''' '''
import importlib.util import importlib.util
path: Optional[str] = None path: str | None = None
try: try:
# TODO annoying, this can cause import of the parent module? # TODO annoying, this can cause import of the parent module?
spec = importlib.util.find_spec(module) spec = importlib.util.find_spec(module)
@ -35,7 +38,7 @@ def is_not_hpi_module(module: str) -> Optional[str]:
except Exception as e: except Exception as e:
# todo a bit misleading.. it actually shouldn't import in most cases, it's just the weird parent module import thing # todo a bit misleading.. it actually shouldn't import in most cases, it's just the weird parent module import thing
return "import error (possibly missing config entry)" # todo add exc message? return "import error (possibly missing config entry)" # todo add exc message?
assert path is not None # not sure if can happen? assert path is not None # not sure if can happen?
if _is_not_module_src(Path(path)): if _is_not_module_src(Path(path)):
return f"marked explicitly (via {NOT_HPI_MODULE_VAR})" return f"marked explicitly (via {NOT_HPI_MODULE_VAR})"
@ -57,9 +60,10 @@ def _iter_all_importables(pkg: ModuleType) -> Iterable[HPIModule]:
def _discover_path_importables(pkg_pth: Path, pkg_name: str) -> Iterable[HPIModule]: def _discover_path_importables(pkg_pth: Path, pkg_name: str) -> Iterable[HPIModule]:
from .core_config import config
"""Yield all importables under a given path and package.""" """Yield all importables under a given path and package."""
from .core_config import config # noqa: F401
for dir_path, dirs, file_names in os.walk(pkg_pth): for dir_path, dirs, file_names in os.walk(pkg_pth):
file_names.sort() file_names.sort()
# NOTE: sorting dirs in place is intended, it's the way you're supposed to do it with os.walk # NOTE: sorting dirs in place is intended, it's the way you're supposed to do it with os.walk
@ -82,6 +86,7 @@ def _discover_path_importables(pkg_pth: Path, pkg_name: str) -> Iterable[HPIModu
# TODO might need to make it defensive and yield Exception (otherwise hpi doctor might fail for no good reason) # TODO might need to make it defensive and yield Exception (otherwise hpi doctor might fail for no good reason)
# use onerror=? # use onerror=?
# ignored explicitly -> not HPI # ignored explicitly -> not HPI
# if enabled in config -> HPI # if enabled in config -> HPI
# if disabled in config -> HPI # if disabled in config -> HPI
@ -90,7 +95,7 @@ def _discover_path_importables(pkg_pth: Path, pkg_name: str) -> Iterable[HPIModu
# TODO when do we need to recurse? # TODO when do we need to recurse?
def _walk_packages(path: Iterable[str], prefix: str='', onerror=None) -> Iterable[HPIModule]: def _walk_packages(path: Iterable[str], prefix: str = '', onerror=None) -> Iterable[HPIModule]:
""" """
Modified version of https://github.com/python/cpython/blob/d50a0700265536a20bcce3fb108c954746d97625/Lib/pkgutil.py#L53, Modified version of https://github.com/python/cpython/blob/d50a0700265536a20bcce3fb108c954746d97625/Lib/pkgutil.py#L53,
to avoid importing modules that are skipped to avoid importing modules that are skipped
@ -153,8 +158,9 @@ def _walk_packages(path: Iterable[str], prefix: str='', onerror=None) -> Iterabl
path = [p for p in path if not seen(p)] path = [p for p in path if not seen(p)]
yield from _walk_packages(path, mname + '.', onerror) yield from _walk_packages(path, mname + '.', onerror)
# deprecate? # deprecate?
def get_modules() -> List[HPIModule]: def get_modules() -> list[HPIModule]:
return list(modules()) return list(modules())
@ -169,14 +175,14 @@ def test_module_detection() -> None:
with reset() as cc: with reset() as cc:
cc.disabled_modules = ['my.location.*', 'my.body.*', 'my.workouts.*', 'my.private.*'] cc.disabled_modules = ['my.location.*', 'my.body.*', 'my.workouts.*', 'my.private.*']
mods = {m.name: m for m in modules()} mods = {m.name: m for m in modules()}
assert mods['my.demo'] .skip_reason == "has no 'stats()' function" assert mods['my.demo'].skip_reason == "has no 'stats()' function"
with reset() as cc: with reset() as cc:
cc.disabled_modules = ['my.location.*', 'my.body.*', 'my.workouts.*', 'my.private.*', 'my.lastfm'] cc.disabled_modules = ['my.location.*', 'my.body.*', 'my.workouts.*', 'my.private.*', 'my.lastfm']
cc.enabled_modules = ['my.demo'] cc.enabled_modules = ['my.demo']
mods = {m.name: m for m in modules()} mods = {m.name: m for m in modules()}
assert mods['my.demo'] .skip_reason is None # not skipped assert mods['my.demo'].skip_reason is None # not skipped
assert mods['my.lastfm'].skip_reason == "suppressed in the user config" assert mods['my.lastfm'].skip_reason == "suppressed in the user config"

View file

@ -1,6 +1,7 @@
import sys from __future__ import annotations
from concurrent.futures import Executor, Future from concurrent.futures import Executor, Future
from typing import Any, Callable, Optional, TypeVar from typing import Any, Callable, TypeVar
from ..compat import ParamSpec from ..compat import ParamSpec
@ -15,7 +16,7 @@ class DummyExecutor(Executor):
but also want to provide an option to run the code serially (e.g. for debugging) but also want to provide an option to run the code serially (e.g. for debugging)
""" """
def __init__(self, max_workers: Optional[int] = 1) -> None: def __init__(self, max_workers: int | None = 1) -> None:
self._shutdown = False self._shutdown = False
self._max_workers = max_workers self._max_workers = max_workers

View file

@ -1,27 +1,27 @@
from __future__ import annotations
import importlib import importlib
import importlib.util import importlib.util
import sys import sys
from pathlib import Path from pathlib import Path
from types import ModuleType from types import ModuleType
from typing import Optional
from ..common import PathIsh
# TODO only used in tests? not sure if useful at all. # TODO only used in tests? not sure if useful at all.
def import_file(p: PathIsh, name: Optional[str] = None) -> ModuleType: def import_file(p: Path | str, name: str | None = None) -> ModuleType:
p = Path(p) p = Path(p)
if name is None: if name is None:
name = p.stem name = p.stem
spec = importlib.util.spec_from_file_location(name, p) spec = importlib.util.spec_from_file_location(name, p)
assert spec is not None, f"Fatal error; Could not create module spec from {name} {p}" assert spec is not None, f"Fatal error; Could not create module spec from {name} {p}"
foo = importlib.util.module_from_spec(spec) foo = importlib.util.module_from_spec(spec)
loader = spec.loader; assert loader is not None loader = spec.loader
assert loader is not None
loader.exec_module(foo) loader.exec_module(foo)
return foo return foo
def import_from(path: PathIsh, name: str) -> ModuleType: def import_from(path: Path | str, name: str) -> ModuleType:
path = str(path) path = str(path)
sys.path.append(path) sys.path.append(path)
try: try:
@ -30,7 +30,7 @@ def import_from(path: PathIsh, name: str) -> ModuleType:
sys.path.remove(path) sys.path.remove(path)
def import_dir(path: PathIsh, extra: str = '') -> ModuleType: def import_dir(path: Path | str, extra: str = '') -> ModuleType:
p = Path(path) p = Path(path)
if p.parts[0] == '~': if p.parts[0] == '~':
p = p.expanduser() # TODO eh. not sure about this.. p = p.expanduser() # TODO eh. not sure about this..

View file

@ -4,17 +4,13 @@ Various helpers/transforms of iterators
Ideally this should be as small as possible and we should rely on stdlib itertools or more_itertools Ideally this should be as small as possible and we should rely on stdlib itertools or more_itertools
""" """
from __future__ import annotations
import warnings import warnings
from collections.abc import Hashable from collections.abc import Hashable, Iterable, Iterator, Sized
from typing import ( from typing import (
TYPE_CHECKING, TYPE_CHECKING,
Callable, Callable,
Dict,
Iterable,
Iterator,
List,
Optional,
Sized,
TypeVar, TypeVar,
Union, Union,
cast, cast,
@ -23,9 +19,8 @@ from typing import (
import more_itertools import more_itertools
from decorator import decorator from decorator import decorator
from ..compat import ParamSpec
from .. import warnings as core_warnings from .. import warnings as core_warnings
from ..compat import ParamSpec
T = TypeVar('T') T = TypeVar('T')
K = TypeVar('K') K = TypeVar('K')
@ -39,7 +34,7 @@ def _identity(v: T) -> V: # type: ignore[type-var]
# ugh. nothing in more_itertools? # ugh. nothing in more_itertools?
# perhaps duplicates_everseen? but it doesn't yield non-unique elements? # perhaps duplicates_everseen? but it doesn't yield non-unique elements?
def ensure_unique(it: Iterable[T], *, key: Callable[[T], K]) -> Iterable[T]: def ensure_unique(it: Iterable[T], *, key: Callable[[T], K]) -> Iterable[T]:
key2item: Dict[K, T] = {} key2item: dict[K, T] = {}
for i in it: for i in it:
k = key(i) k = key(i)
pi = key2item.get(k, None) pi = key2item.get(k, None)
@ -72,10 +67,10 @@ def make_dict(
key: Callable[[T], K], key: Callable[[T], K],
# TODO make value optional instead? but then will need a typing override for it? # TODO make value optional instead? but then will need a typing override for it?
value: Callable[[T], V] = _identity, value: Callable[[T], V] = _identity,
) -> Dict[K, V]: ) -> dict[K, V]:
with_keys = ((key(i), i) for i in it) with_keys = ((key(i), i) for i in it)
uniques = ensure_unique(with_keys, key=lambda p: p[0]) uniques = ensure_unique(with_keys, key=lambda p: p[0])
res: Dict[K, V] = {} res: dict[K, V] = {}
for k, i in uniques: for k, i in uniques:
res[k] = i if value is None else value(i) res[k] = i if value is None else value(i)
return res return res
@ -93,8 +88,8 @@ def test_make_dict() -> None:
d = make_dict(it, key=lambda i: i % 2, value=lambda i: i) d = make_dict(it, key=lambda i: i % 2, value=lambda i: i)
# check type inference # check type inference
d2: Dict[str, int] = make_dict(it, key=lambda i: str(i)) d2: dict[str, int] = make_dict(it, key=lambda i: str(i))
d3: Dict[str, bool] = make_dict(it, key=lambda i: str(i), value=lambda i: i % 2 == 0) d3: dict[str, bool] = make_dict(it, key=lambda i: str(i), value=lambda i: i % 2 == 0)
LFP = ParamSpec('LFP') LFP = ParamSpec('LFP')
@ -102,7 +97,7 @@ LV = TypeVar('LV')
@decorator @decorator
def _listify(func: Callable[LFP, Iterable[LV]], *args: LFP.args, **kwargs: LFP.kwargs) -> List[LV]: def _listify(func: Callable[LFP, Iterable[LV]], *args: LFP.args, **kwargs: LFP.kwargs) -> list[LV]:
""" """
Wraps a function's return value in wrapper (e.g. list) Wraps a function's return value in wrapper (e.g. list)
Useful when an algorithm can be expressed more cleanly as a generator Useful when an algorithm can be expressed more cleanly as a generator
@ -115,7 +110,7 @@ def _listify(func: Callable[LFP, Iterable[LV]], *args: LFP.args, **kwargs: LFP.k
# so seems easiest to just use specialize instantiations of decorator instead # so seems easiest to just use specialize instantiations of decorator instead
if TYPE_CHECKING: if TYPE_CHECKING:
def listify(func: Callable[LFP, Iterable[LV]]) -> Callable[LFP, List[LV]]: ... # noqa: ARG001 def listify(func: Callable[LFP, Iterable[LV]]) -> Callable[LFP, list[LV]]: ... # noqa: ARG001
else: else:
listify = _listify listify = _listify
@ -130,7 +125,7 @@ def test_listify() -> None:
yield 2 yield 2
res = it() res = it()
assert_type(res, List[int]) assert_type(res, list[int])
assert res == [1, 2] assert res == [1, 2]
@ -201,24 +196,24 @@ def test_warn_if_empty_list() -> None:
ll = [1, 2, 3] ll = [1, 2, 3]
@warn_if_empty @warn_if_empty
def nonempty() -> List[int]: def nonempty() -> list[int]:
return ll return ll
with warnings.catch_warnings(record=True) as w: with warnings.catch_warnings(record=True) as w:
res1 = nonempty() res1 = nonempty()
assert len(w) == 0 assert len(w) == 0
assert_type(res1, List[int]) assert_type(res1, list[int])
assert isinstance(res1, list) assert isinstance(res1, list)
assert res1 is ll # object should be unchanged! assert res1 is ll # object should be unchanged!
@warn_if_empty @warn_if_empty
def empty() -> List[str]: def empty() -> list[str]:
return [] return []
with warnings.catch_warnings(record=True) as w: with warnings.catch_warnings(record=True) as w:
res2 = empty() res2 = empty()
assert len(w) == 1 assert len(w) == 1
assert_type(res2, List[str]) assert_type(res2, list[str])
assert isinstance(res2, list) assert isinstance(res2, list)
assert res2 == [] assert res2 == []
@ -242,7 +237,7 @@ def check_if_hashable(iterable: Iterable[_HT]) -> Iterable[_HT]:
""" """
NOTE: Despite Hashable bound, typing annotation doesn't guarantee runtime safety NOTE: Despite Hashable bound, typing annotation doesn't guarantee runtime safety
Consider hashable type X, and Y that inherits from X, but not hashable Consider hashable type X, and Y that inherits from X, but not hashable
Then l: List[X] = [Y(...)] is a valid expression, and type checks against Hashable, Then l: list[X] = [Y(...)] is a valid expression, and type checks against Hashable,
but isn't runtime hashable but isn't runtime hashable
""" """
# Sadly this doesn't work 100% correctly with dataclasses atm... # Sadly this doesn't work 100% correctly with dataclasses atm...
@ -268,28 +263,27 @@ def check_if_hashable(iterable: Iterable[_HT]) -> Iterable[_HT]:
# TODO different policies -- error/warn/ignore? # TODO different policies -- error/warn/ignore?
def test_check_if_hashable() -> None: def test_check_if_hashable() -> None:
from dataclasses import dataclass from dataclasses import dataclass
from typing import Set, Tuple
import pytest import pytest
from ..compat import assert_type from ..compat import assert_type
x1: List[int] = [1, 2] x1: list[int] = [1, 2]
r1 = check_if_hashable(x1) r1 = check_if_hashable(x1)
assert_type(r1, Iterable[int]) assert_type(r1, Iterable[int])
assert r1 is x1 assert r1 is x1
x2: Iterator[Union[int, str]] = iter((123, 'aba')) x2: Iterator[int | str] = iter((123, 'aba'))
r2 = check_if_hashable(x2) r2 = check_if_hashable(x2)
assert_type(r2, Iterable[Union[int, str]]) assert_type(r2, Iterable[Union[int, str]])
assert list(r2) == [123, 'aba'] assert list(r2) == [123, 'aba']
x3: Tuple[object, ...] = (789, 'aba') x3: tuple[object, ...] = (789, 'aba')
r3 = check_if_hashable(x3) r3 = check_if_hashable(x3)
assert_type(r3, Iterable[object]) assert_type(r3, Iterable[object])
assert r3 is x3 # object should be unchanged assert r3 is x3 # object should be unchanged
x4: List[Set[int]] = [{1, 2, 3}, {4, 5, 6}] x4: list[set[int]] = [{1, 2, 3}, {4, 5, 6}]
with pytest.raises(Exception): with pytest.raises(Exception):
# should be rejected by mypy sice set isn't Hashable, but also throw at runtime # should be rejected by mypy sice set isn't Hashable, but also throw at runtime
r4 = check_if_hashable(x4) # type: ignore[type-var] r4 = check_if_hashable(x4) # type: ignore[type-var]
@ -307,7 +301,7 @@ def test_check_if_hashable() -> None:
class X: class X:
a: int a: int
x6: List[X] = [X(a=123)] x6: list[X] = [X(a=123)]
r6 = check_if_hashable(x6) r6 = check_if_hashable(x6)
assert x6 is r6 assert x6 is r6
@ -316,7 +310,7 @@ def test_check_if_hashable() -> None:
class Y(X): class Y(X):
b: str b: str
x7: List[Y] = [Y(a=123, b='aba')] x7: list[Y] = [Y(a=123, b='aba')]
with pytest.raises(Exception): with pytest.raises(Exception):
# ideally that would also be rejected by mypy, but currently there is a bug # ideally that would also be rejected by mypy, but currently there is a bug
# which treats all dataclasses as hashable: https://github.com/python/mypy/issues/11463 # which treats all dataclasses as hashable: https://github.com/python/mypy/issues/11463
@ -327,15 +321,12 @@ _UET = TypeVar('_UET')
_UEU = TypeVar('_UEU') _UEU = TypeVar('_UEU')
# NOTE: for historic reasons, this function had to accept Callable that retuns iterator # NOTE: for historic reasons, this function had to accept Callable that returns iterator
# instead of just iterator # instead of just iterator
# TODO maybe deprecated Callable support? not sure # TODO maybe deprecated Callable support? not sure
def unique_everseen( def unique_everseen(
fun: Union[ fun: Callable[[], Iterable[_UET]] | Iterable[_UET],
Callable[[], Iterable[_UET]], key: Callable[[_UET], _UEU] | None = None,
Iterable[_UET]
],
key: Optional[Callable[[_UET], _UEU]] = None,
) -> Iterator[_UET]: ) -> Iterator[_UET]:
import os import os
@ -367,7 +358,7 @@ def test_unique_everseen() -> None:
assert list(unique_everseen(fun_good)) == [123] assert list(unique_everseen(fun_good)) == [123]
with pytest.raises(Exception): with pytest.raises(Exception):
# since function retuns a list rather than iterator, check happens immediately # since function returns a list rather than iterator, check happens immediately
# , even without advancing the iterator # , even without advancing the iterator
unique_everseen(fun_bad) unique_everseen(fun_bad)

View file

@ -5,14 +5,16 @@ since who looks at the terminal output?
E.g. would be nice to propagate the warnings in the UI (it's even a subclass of Exception!) E.g. would be nice to propagate the warnings in the UI (it's even a subclass of Exception!)
''' '''
from __future__ import annotations
import sys import sys
import warnings import warnings
from typing import TYPE_CHECKING, Optional from typing import TYPE_CHECKING
import click import click
def _colorize(x: str, color: Optional[str] = None) -> str: def _colorize(x: str, color: str | None = None) -> str:
if color is None: if color is None:
return x return x
@ -24,7 +26,7 @@ def _colorize(x: str, color: Optional[str] = None) -> str:
return click.style(x, fg=color) return click.style(x, fg=color)
def _warn(message: str, *args, color: Optional[str] = None, **kwargs) -> None: def _warn(message: str, *args, color: str | None = None, **kwargs) -> None:
stacklevel = kwargs.get('stacklevel', 1) stacklevel = kwargs.get('stacklevel', 1)
kwargs['stacklevel'] = stacklevel + 2 # +1 for this function, +1 for medium/high wrapper kwargs['stacklevel'] = stacklevel + 2 # +1 for this function, +1 for medium/high wrapper
warnings.warn(_colorize(message, color=color), *args, **kwargs) # noqa: B028 warnings.warn(_colorize(message, color=color), *args, **kwargs) # noqa: B028

View file

@ -1,12 +1,14 @@
''' '''
Just a demo module for testing and documentation purposes Just a demo module for testing and documentation purposes
''' '''
from __future__ import annotations
import json import json
from collections.abc import Iterable, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timezone, tzinfo from datetime import datetime, timezone, tzinfo
from pathlib import Path from pathlib import Path
from typing import Iterable, Optional, Protocol, Sequence from typing import Protocol
from my.core import Json, PathIsh, Paths, get_files from my.core import Json, PathIsh, Paths, get_files
@ -20,7 +22,7 @@ class config(Protocol):
# this is to check optional attribute handling # this is to check optional attribute handling
timezone: tzinfo = timezone.utc timezone: tzinfo = timezone.utc
external: Optional[PathIsh] = None external: PathIsh | None = None
@property @property
def external_module(self): def external_module(self):

View file

@ -4,31 +4,34 @@
Consumes data exported by https://github.com/karlicoss/emfitexport Consumes data exported by https://github.com/karlicoss/emfitexport
""" """
from __future__ import annotations
REQUIRES = [ REQUIRES = [
'git+https://github.com/karlicoss/emfitexport', 'git+https://github.com/karlicoss/emfitexport',
] ]
from contextlib import contextmanager
import dataclasses import dataclasses
from datetime import datetime, time, timedelta
import inspect import inspect
from collections.abc import Iterable, Iterator
from contextlib import contextmanager
from datetime import datetime, time, timedelta
from pathlib import Path from pathlib import Path
from typing import Any, Dict, Iterable, Iterator, List, Optional from typing import Any
from my.core import (
get_files,
stat,
Res,
Stats,
)
from my.core.cachew import cache_dir, mcachew
from my.core.error import set_error_datetime, extract_error_datetime
from my.core.pandas import DataFrameT
from my.config import emfit as config
import emfitexport.dal as dal import emfitexport.dal as dal
from my.core import (
Res,
Stats,
get_files,
stat,
)
from my.core.cachew import cache_dir, mcachew
from my.core.error import extract_error_datetime, set_error_datetime
from my.core.pandas import DataFrameT
from my.config import emfit as config # isort: skip
Emfit = dal.Emfit Emfit = dal.Emfit
@ -85,7 +88,7 @@ def datas() -> Iterable[Res[Emfit]]:
# TODO should be used for jawbone data as well? # TODO should be used for jawbone data as well?
def pre_dataframe() -> Iterable[Res[Emfit]]: def pre_dataframe() -> Iterable[Res[Emfit]]:
# TODO shit. I need some sort of interrupted sleep detection? # TODO shit. I need some sort of interrupted sleep detection?
g: List[Emfit] = [] g: list[Emfit] = []
def flush() -> Iterable[Res[Emfit]]: def flush() -> Iterable[Res[Emfit]]:
if len(g) == 0: if len(g) == 0:
@ -112,10 +115,10 @@ def pre_dataframe() -> Iterable[Res[Emfit]]:
def dataframe() -> DataFrameT: def dataframe() -> DataFrameT:
dicts: List[Dict[str, Any]] = [] dicts: list[dict[str, Any]] = []
last: Optional[Emfit] = None last: Emfit | None = None
for s in pre_dataframe(): for s in pre_dataframe():
d: Dict[str, Any] d: dict[str, Any]
if isinstance(s, Exception): if isinstance(s, Exception):
edt = extract_error_datetime(s) edt = extract_error_datetime(s)
d = { d = {
@ -166,11 +169,12 @@ def stats() -> Stats:
@contextmanager @contextmanager
def fake_data(nights: int = 500) -> Iterator: def fake_data(nights: int = 500) -> Iterator:
from my.core.cfg import tmp_config
from tempfile import TemporaryDirectory from tempfile import TemporaryDirectory
import pytz import pytz
from my.core.cfg import tmp_config
with TemporaryDirectory() as td: with TemporaryDirectory() as td:
tdir = Path(td) tdir = Path(td)
gen = dal.FakeData() gen = dal.FakeData()
@ -187,7 +191,7 @@ def fake_data(nights: int = 500) -> Iterator:
# TODO remove/deprecate it? I think used by timeline # TODO remove/deprecate it? I think used by timeline
def get_datas() -> List[Emfit]: def get_datas() -> list[Emfit]:
# todo ugh. run lint properly # todo ugh. run lint properly
return sorted(datas(), key=lambda e: e.start) # type: ignore return sorted(datas(), key=lambda e: e.start) # type: ignore

View file

@ -7,13 +7,14 @@ REQUIRES = [
] ]
# todo use ast in setup.py or doctor to extract the corresponding pip packages? # todo use ast in setup.py or doctor to extract the corresponding pip packages?
from collections.abc import Iterable, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from pathlib import Path from pathlib import Path
from typing import Sequence, Iterable
from my.config import endomondo as user_config
from .core import Paths, get_files from .core import Paths, get_files
from my.config import endomondo as user_config
@dataclass @dataclass
class endomondo(user_config): class endomondo(user_config):
@ -33,15 +34,17 @@ def inputs() -> Sequence[Path]:
import endoexport.dal as dal import endoexport.dal as dal
from endoexport.dal import Point, Workout # noqa: F401 from endoexport.dal import Point, Workout # noqa: F401
from .core import Res from .core import Res
# todo cachew? # todo cachew?
def workouts() -> Iterable[Res[Workout]]: def workouts() -> Iterable[Res[Workout]]:
_dal = dal.DAL(inputs()) _dal = dal.DAL(inputs())
yield from _dal.workouts() yield from _dal.workouts()
from .core.pandas import check_dataframe, DataFrameT from .core.pandas import DataFrameT, check_dataframe
@check_dataframe @check_dataframe
def dataframe(*, defensive: bool=True) -> DataFrameT: def dataframe(*, defensive: bool=True) -> DataFrameT:
@ -75,7 +78,9 @@ def dataframe(*, defensive: bool=True) -> DataFrameT:
return df return df
from .core import stat, Stats from .core import Stats, stat
def stats() -> Stats: def stats() -> Stats:
return { return {
# todo pretty print stats? # todo pretty print stats?
@ -86,13 +91,16 @@ def stats() -> Stats:
# TODO make sure it's possible to 'advise' functions and override stuff # TODO make sure it's possible to 'advise' functions and override stuff
from collections.abc import Iterator
from contextlib import contextmanager from contextlib import contextmanager
from typing import Iterator
@contextmanager @contextmanager
def fake_data(count: int=100) -> Iterator: def fake_data(count: int=100) -> Iterator:
from my.core.cfg import tmp_config
from tempfile import TemporaryDirectory
import json import json
from tempfile import TemporaryDirectory
from my.core.cfg import tmp_config
with TemporaryDirectory() as td: with TemporaryDirectory() as td:
tdir = Path(td) tdir = Path(td)
fd = dal.FakeData() fd = dal.FakeData()

View file

@ -1,6 +1,6 @@
from .core.warnings import high from .core.warnings import high
high("DEPRECATED! Please use my.core.error instead.") high("DEPRECATED! Please use my.core.error instead.")
from .core import __NOT_HPI_MODULE__ from .core import __NOT_HPI_MODULE__
from .core.error import * from .core.error import *

View file

@ -1,5 +1,6 @@
from collections.abc import Iterator
from dataclasses import dataclass from dataclasses import dataclass
from typing import Any, Iterator, List, Tuple from typing import Any
from my.core.compat import NoneType, assert_never from my.core.compat import NoneType, assert_never
@ -9,7 +10,7 @@ from my.core.compat import NoneType, assert_never
class Helper: class Helper:
manager: 'Manager' manager: 'Manager'
item: Any # todo realistically, list or dict? could at least type as indexable or something item: Any # todo realistically, list or dict? could at least type as indexable or something
path: Tuple[str, ...] path: tuple[str, ...]
def pop_if_primitive(self, *keys: str) -> None: def pop_if_primitive(self, *keys: str) -> None:
""" """
@ -40,9 +41,9 @@ def is_empty(x) -> bool:
class Manager: class Manager:
def __init__(self) -> None: def __init__(self) -> None:
self.helpers: List[Helper] = [] self.helpers: list[Helper] = []
def helper(self, item: Any, *, path: Tuple[str, ...] = ()) -> Helper: def helper(self, item: Any, *, path: tuple[str, ...] = ()) -> Helper:
res = Helper(manager=self, item=item, path=path) res = Helper(manager=self, item=item, path=path)
self.helpers.append(res) self.helpers.append(res)
return res return res

View file

@ -9,7 +9,7 @@ since that allows for easier overriding using namespace packages
See https://github.com/karlicoss/HPI/blob/master/doc/MODULE_DESIGN.org#allpy for more info. See https://github.com/karlicoss/HPI/blob/master/doc/MODULE_DESIGN.org#allpy for more info.
""" """
# prevent it from apprearing in modules list/doctor # prevent it from appearing in modules list/doctor
from ..core import __NOT_HPI_MODULE__ from ..core import __NOT_HPI_MODULE__
# kinda annoying to keep it, but it's so legacy 'hpi module install my.fbmessenger' works # kinda annoying to keep it, but it's so legacy 'hpi module install my.fbmessenger' works
@ -20,6 +20,7 @@ REQUIRES = [
from my.core.hpi_compat import handle_legacy_import from my.core.hpi_compat import handle_legacy_import
is_legacy_import = handle_legacy_import( is_legacy_import = handle_legacy_import(
parent_module_name=__name__, parent_module_name=__name__,
legacy_submodule_name='export', legacy_submodule_name='export',

View file

@ -1,10 +1,10 @@
from typing import Iterator from collections.abc import Iterator
from my.core import Res, stat, Stats
from my.core import Res, Stats
from my.core.source import import_source from my.core.source import import_source
from .common import Message, _merge_messages from .common import Message, _merge_messages
src_export = import_source(module_name='my.fbmessenger.export') src_export = import_source(module_name='my.fbmessenger.export')
src_android = import_source(module_name='my.fbmessenger.android') src_android = import_source(module_name='my.fbmessenger.android')

View file

@ -4,19 +4,20 @@ Messenger data from Android app database (in =/data/data/com.facebook.orca/datab
from __future__ import annotations from __future__ import annotations
import sqlite3
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timezone from datetime import datetime, timezone
from pathlib import Path from pathlib import Path
import sqlite3 from typing import Union
from typing import Iterator, Sequence, Optional, Dict, Union, List
from my.core import get_files, Paths, datetime_aware, Res, LazyLogger, make_config from my.core import LazyLogger, Paths, Res, datetime_aware, get_files, make_config
from my.core.common import unique_everseen from my.core.common import unique_everseen
from my.core.compat import assert_never from my.core.compat import assert_never
from my.core.error import echain from my.core.error import echain
from my.core.sqlite import sqlite_connection from my.core.sqlite import sqlite_connection, SqliteTool
from my.config import fbmessenger as user_config from my.config import fbmessenger as user_config # isort: skip
logger = LazyLogger(__name__) logger = LazyLogger(__name__)
@ -27,7 +28,7 @@ class Config(user_config.android):
# paths[s]/glob to the exported sqlite databases # paths[s]/glob to the exported sqlite databases
export_path: Paths export_path: Paths
facebook_id: Optional[str] = None facebook_id: str | None = None
# hmm. this is necessary for default value (= None) to work # hmm. this is necessary for default value (= None) to work
@ -42,13 +43,13 @@ def inputs() -> Sequence[Path]:
@dataclass(unsafe_hash=True) @dataclass(unsafe_hash=True)
class Sender: class Sender:
id: str id: str
name: Optional[str] name: str | None
@dataclass(unsafe_hash=True) @dataclass(unsafe_hash=True)
class Thread: class Thread:
id: str id: str
name: Optional[str] # isn't set for groups or one to one messages name: str | None # isn't set for groups or one to one messages
# todo not sure about order of fields... # todo not sure about order of fields...
@ -56,14 +57,14 @@ class Thread:
class _BaseMessage: class _BaseMessage:
id: str id: str
dt: datetime_aware dt: datetime_aware
text: Optional[str] text: str | None
@dataclass(unsafe_hash=True) @dataclass(unsafe_hash=True)
class _Message(_BaseMessage): class _Message(_BaseMessage):
thread_id: str thread_id: str
sender_id: str sender_id: str
reply_to_id: Optional[str] reply_to_id: str | None
# todo hmm, on the one hand would be kinda nice to inherit common.Message protocol here # todo hmm, on the one hand would be kinda nice to inherit common.Message protocol here
@ -72,7 +73,7 @@ class _Message(_BaseMessage):
class Message(_BaseMessage): class Message(_BaseMessage):
thread: Thread thread: Thread
sender: Sender sender: Sender
reply_to: Optional[Message] reply_to: Message | None
Entity = Union[Sender, Thread, _Message] Entity = Union[Sender, Thread, _Message]
@ -85,8 +86,8 @@ def _entities() -> Iterator[Res[Entity]]:
for idx, path in enumerate(paths): for idx, path in enumerate(paths):
logger.info(f'processing [{idx:>{width}}/{total:>{width}}] {path}') logger.info(f'processing [{idx:>{width}}/{total:>{width}}] {path}')
with sqlite_connection(path, immutable=True, row_factory='row') as db: with sqlite_connection(path, immutable=True, row_factory='row') as db:
use_msys = "logging_events_v2" in SqliteTool(db).get_table_names()
try: try:
use_msys = len(list(db.execute('SELECT * FROM sqlite_master WHERE name = "logging_events_v2"'))) > 0
if use_msys: if use_msys:
yield from _process_db_msys(db) yield from _process_db_msys(db)
else: else:
@ -110,7 +111,7 @@ def _normalise_thread_id(key) -> str:
# NOTE: this is sort of copy pasted from other _process_db method # NOTE: this is sort of copy pasted from other _process_db method
# maybe later could unify them # maybe later could unify them
def _process_db_msys(db: sqlite3.Connection) -> Iterator[Res[Entity]]: def _process_db_msys(db: sqlite3.Connection) -> Iterator[Res[Entity]]:
senders: Dict[str, Sender] = {} senders: dict[str, Sender] = {}
for r in db.execute('SELECT CAST(id AS TEXT) AS id, name FROM contacts'): for r in db.execute('SELECT CAST(id AS TEXT) AS id, name FROM contacts'):
s = Sender( s = Sender(
id=r['id'], # looks like it's server id? same used on facebook site id=r['id'], # looks like it's server id? same used on facebook site
@ -127,7 +128,7 @@ def _process_db_msys(db: sqlite3.Connection) -> Iterator[Res[Entity]]:
# TODO can we get it from db? could infer as the most common id perhaps? # TODO can we get it from db? could infer as the most common id perhaps?
self_id = config.facebook_id self_id = config.facebook_id
thread_users: Dict[str, List[Sender]] = {} thread_users: dict[str, list[Sender]] = {}
for r in db.execute('SELECT CAST(thread_key AS TEXT) AS thread_key, CAST(contact_id AS TEXT) AS contact_id FROM participants'): for r in db.execute('SELECT CAST(thread_key AS TEXT) AS thread_key, CAST(contact_id AS TEXT) AS contact_id FROM participants'):
thread_key = r['thread_key'] thread_key = r['thread_key']
user_key = r['contact_id'] user_key = r['contact_id']
@ -173,7 +174,7 @@ def _process_db_msys(db: sqlite3.Connection) -> Iterator[Res[Entity]]:
However seems that when message is not sent yet it doesn't have this server id yet However seems that when message is not sent yet it doesn't have this server id yet
(happened only once, but could be just luck of course!) (happened only once, but could be just luck of course!)
We exclude these messages to avoid duplication. We exclude these messages to avoid duplication.
However poisitive filter (e.g. message_id LIKE 'mid%') feels a bit wrong, e.g. what if mesage ids change or something However poisitive filter (e.g. message_id LIKE 'mid%') feels a bit wrong, e.g. what if message ids change or something
So instead this excludes only such unsent messages. So instead this excludes only such unsent messages.
*/ */
message_id != offline_threading_id message_id != offline_threading_id
@ -193,7 +194,7 @@ def _process_db_msys(db: sqlite3.Connection) -> Iterator[Res[Entity]]:
def _process_db_threads_db2(db: sqlite3.Connection) -> Iterator[Res[Entity]]: def _process_db_threads_db2(db: sqlite3.Connection) -> Iterator[Res[Entity]]:
senders: Dict[str, Sender] = {} senders: dict[str, Sender] = {}
for r in db.execute('''SELECT * FROM thread_users'''): for r in db.execute('''SELECT * FROM thread_users'''):
# for messaging_actor_type == 'REDUCED_MESSAGING_ACTOR', name is None # for messaging_actor_type == 'REDUCED_MESSAGING_ACTOR', name is None
# but they are still referenced, so need to keep # but they are still referenced, so need to keep
@ -207,7 +208,7 @@ def _process_db_threads_db2(db: sqlite3.Connection) -> Iterator[Res[Entity]]:
yield s yield s
self_id = config.facebook_id self_id = config.facebook_id
thread_users: Dict[str, List[Sender]] = {} thread_users: dict[str, list[Sender]] = {}
for r in db.execute('SELECT * from thread_participants'): for r in db.execute('SELECT * from thread_participants'):
thread_key = r['thread_key'] thread_key = r['thread_key']
user_key = r['user_key'] user_key = r['user_key']
@ -267,9 +268,9 @@ def contacts() -> Iterator[Res[Sender]]:
def messages() -> Iterator[Res[Message]]: def messages() -> Iterator[Res[Message]]:
senders: Dict[str, Sender] = {} senders: dict[str, Sender] = {}
msgs: Dict[str, Message] = {} msgs: dict[str, Message] = {}
threads: Dict[str, Thread] = {} threads: dict[str, Thread] = {}
for x in unique_everseen(_entities): for x in unique_everseen(_entities):
if isinstance(x, Exception): if isinstance(x, Exception):
yield x yield x

View file

@ -1,6 +1,9 @@
from my.core import __NOT_HPI_MODULE__ from __future__ import annotations
from typing import Iterator, Optional, Protocol from my.core import __NOT_HPI_MODULE__ # isort: skip
from collections.abc import Iterator
from typing import Protocol
from my.core import datetime_aware from my.core import datetime_aware
@ -10,7 +13,7 @@ class Thread(Protocol):
def id(self) -> str: ... def id(self) -> str: ...
@property @property
def name(self) -> Optional[str]: ... def name(self) -> str | None: ...
class Sender(Protocol): class Sender(Protocol):
@ -18,7 +21,7 @@ class Sender(Protocol):
def id(self) -> str: ... def id(self) -> str: ...
@property @property
def name(self) -> Optional[str]: ... def name(self) -> str | None: ...
class Message(Protocol): class Message(Protocol):
@ -29,7 +32,7 @@ class Message(Protocol):
def dt(self) -> datetime_aware: ... def dt(self) -> datetime_aware: ...
@property @property
def text(self) -> Optional[str]: ... def text(self) -> str | None: ...
@property @property
def thread(self) -> Thread: ... def thread(self) -> Thread: ...
@ -39,8 +42,11 @@ class Message(Protocol):
from itertools import chain from itertools import chain
from more_itertools import unique_everseen from more_itertools import unique_everseen
from my.core import warn_if_empty, Res
from my.core import Res, warn_if_empty
@warn_if_empty @warn_if_empty
def _merge_messages(*sources: Iterator[Res[Message]]) -> Iterator[Res[Message]]: def _merge_messages(*sources: Iterator[Res[Message]]) -> Iterator[Res[Message]]:

View file

@ -7,16 +7,15 @@ REQUIRES = [
'git+https://github.com/karlicoss/fbmessengerexport', 'git+https://github.com/karlicoss/fbmessengerexport',
] ]
from collections.abc import Iterator
from contextlib import ExitStack, contextmanager from contextlib import ExitStack, contextmanager
from dataclasses import dataclass from dataclasses import dataclass
from typing import Iterator
from my.core import PathIsh, Res, stat, Stats
from my.core.warnings import high
from my.config import fbmessenger as user_config
import fbmessengerexport.dal as messenger import fbmessengerexport.dal as messenger
from my.config import fbmessenger as user_config
from my.core import PathIsh, Res, Stats, stat
from my.core.warnings import high
### ###
# support old style config # support old style config

View file

@ -2,15 +2,14 @@
Foursquare/Swarm checkins Foursquare/Swarm checkins
''' '''
from datetime import datetime, timezone, timedelta
from itertools import chain
import json import json
from datetime import datetime, timedelta, timezone
from itertools import chain
# TODO pytz for timezone???
from my.core import get_files, make_logger
from my.config import foursquare as config from my.config import foursquare as config
# TODO pytz for timezone???
from my.core import get_files, make_logger
logger = make_logger(__name__) logger = make_logger(__name__)

View file

@ -3,8 +3,7 @@ Unified Github data (merged from GDPR export and periodic API updates)
""" """
from . import gdpr, ghexport from . import gdpr, ghexport
from .common import Results, merge_events
from .common import merge_events, Results
def events() -> Results: def events() -> Results:

View file

@ -1,24 +1,27 @@
""" """
Github events and their metadata: comments/issues/pull requests Github events and their metadata: comments/issues/pull requests
""" """
from ..core import __NOT_HPI_MODULE__
from __future__ import annotations
from my.core import __NOT_HPI_MODULE__ # isort: skip
from collections.abc import Iterable
from datetime import datetime, timezone from datetime import datetime, timezone
from typing import Optional, NamedTuple, Iterable, Set, Tuple from typing import NamedTuple, Optional
from ..core import warn_if_empty, LazyLogger from my.core import make_logger, warn_if_empty
from ..core.error import Res from my.core.error import Res
logger = make_logger(__name__)
logger = LazyLogger(__name__)
class Event(NamedTuple): class Event(NamedTuple):
dt: datetime dt: datetime
summary: str summary: str
eid: str eid: str
link: Optional[str] link: Optional[str]
body: Optional[str]=None body: Optional[str] = None
is_bot: bool = False is_bot: bool = False
@ -27,7 +30,7 @@ Results = Iterable[Res[Event]]
@warn_if_empty @warn_if_empty
def merge_events(*sources: Results) -> Results: def merge_events(*sources: Results) -> Results:
from itertools import chain from itertools import chain
emitted: Set[Tuple[datetime, str]] = set() emitted: set[tuple[datetime, str]] = set()
for e in chain(*sources): for e in chain(*sources):
if isinstance(e, Exception): if isinstance(e, Exception):
yield e yield e
@ -52,7 +55,7 @@ def parse_dt(s: str) -> datetime:
# experimental way of supportint event ids... not sure # experimental way of supportint event ids... not sure
class EventIds: class EventIds:
@staticmethod @staticmethod
def repo_created(*, dts: str, name: str, ref_type: str, ref: Optional[str]) -> str: def repo_created(*, dts: str, name: str, ref_type: str, ref: str | None) -> str:
return f'{dts}_repocreated_{name}_{ref_type}_{ref}' return f'{dts}_repocreated_{name}_{ref_type}_{ref}'
@staticmethod @staticmethod

View file

@ -6,8 +6,9 @@ from __future__ import annotations
import json import json
from abc import abstractmethod from abc import abstractmethod
from collections.abc import Iterator, Sequence
from pathlib import Path from pathlib import Path
from typing import Any, Iterator, Sequence from typing import Any
from my.core import Paths, Res, Stats, get_files, make_logger, stat, warnings from my.core import Paths, Res, Stats, get_files, make_logger, stat, warnings
from my.core.error import echain from my.core.error import echain

View file

@ -1,13 +1,17 @@
""" """
Github data: events, comments, etc. (API data) Github data: events, comments, etc. (API data)
""" """
from __future__ import annotations
REQUIRES = [ REQUIRES = [
'git+https://github.com/karlicoss/ghexport', 'git+https://github.com/karlicoss/ghexport',
] ]
from dataclasses import dataclass from dataclasses import dataclass
from my.core import Paths
from my.config import github as user_config from my.config import github as user_config
from my.core import Paths
@dataclass @dataclass
@ -21,7 +25,9 @@ class github(user_config):
### ###
from my.core.cfg import make_config, Attrs from my.core.cfg import Attrs, make_config
def migration(attrs: Attrs) -> Attrs: def migration(attrs: Attrs) -> Attrs:
export_dir = 'export_dir' export_dir = 'export_dir'
if export_dir in attrs: # legacy name if export_dir in attrs: # legacy name
@ -41,15 +47,14 @@ except ModuleNotFoundError as e:
############################ ############################
from collections.abc import Sequence
from functools import lru_cache from functools import lru_cache
from pathlib import Path from pathlib import Path
from typing import Tuple, Dict, Sequence, Optional
from my.core import get_files, LazyLogger from my.core import LazyLogger, get_files
from my.core.cachew import mcachew from my.core.cachew import mcachew
from .common import Event, parse_dt, Results, EventIds from .common import Event, EventIds, Results, parse_dt
logger = LazyLogger(__name__) logger = LazyLogger(__name__)
@ -82,7 +87,9 @@ def _events() -> Results:
yield e yield e
from my.core import stat, Stats from my.core import Stats, stat
def stats() -> Stats: def stats() -> Stats:
return { return {
**stat(events), **stat(events),
@ -99,7 +106,7 @@ def _log_if_unhandled(e) -> None:
Link = str Link = str
EventId = str EventId = str
Body = str Body = str
def _get_summary(e) -> Tuple[str, Optional[Link], Optional[EventId], Optional[Body]]: def _get_summary(e) -> tuple[str, Link | None, EventId | None, Body | None]:
# TODO would be nice to give access to raw event within timeline # TODO would be nice to give access to raw event within timeline
dts = e['created_at'] dts = e['created_at']
eid = e['id'] eid = e['id']
@ -195,7 +202,7 @@ def _get_summary(e) -> Tuple[str, Optional[Link], Optional[EventId], Optional[Bo
return tp, None, None, None return tp, None, None, None
def _parse_event(d: Dict) -> Event: def _parse_event(d: dict) -> Event:
summary, link, eid, body = _get_summary(d) summary, link, eid, body = _get_summary(d)
if eid is None: if eid is None:
eid = d['id'] # meh eid = d['id'] # meh

View file

@ -7,15 +7,18 @@ REQUIRES = [
from dataclasses import dataclass from dataclasses import dataclass
from my.core import datetime_aware, Paths
from my.config import goodreads as user_config from my.config import goodreads as user_config
from my.core import Paths, datetime_aware
@dataclass @dataclass
class goodreads(user_config): class goodreads(user_config):
# paths[s]/glob to the exported JSON data # paths[s]/glob to the exported JSON data
export_path: Paths export_path: Paths
from my.core.cfg import make_config, Attrs from my.core.cfg import Attrs, make_config
def _migration(attrs: Attrs) -> Attrs: def _migration(attrs: Attrs) -> Attrs:
export_dir = 'export_dir' export_dir = 'export_dir'
@ -29,18 +32,19 @@ config = make_config(goodreads, migration=_migration)
#############################3 #############################3
from my.core import get_files from collections.abc import Iterator, Sequence
from typing import Sequence, Iterator
from pathlib import Path from pathlib import Path
from my.core import get_files
def inputs() -> Sequence[Path]: def inputs() -> Sequence[Path]:
return get_files(config.export_path) return get_files(config.export_path)
from datetime import datetime from datetime import datetime
import pytz import pytz
from goodrexport import dal from goodrexport import dal

View file

@ -1,8 +1,8 @@
from my.core import __NOT_HPI_MODULE__ from my.core import __NOT_HPI_MODULE__ # isort: skip
# NOTE: this tool was quite useful https://github.com/aj3423/aproto # NOTE: this tool was quite useful https://github.com/aj3423/aproto
from google.protobuf import descriptor_pool, descriptor_pb2, message_factory from google.protobuf import descriptor_pb2, descriptor_pool, message_factory
TYPE_STRING = descriptor_pb2.FieldDescriptorProto.TYPE_STRING TYPE_STRING = descriptor_pb2.FieldDescriptorProto.TYPE_STRING
TYPE_BYTES = descriptor_pb2.FieldDescriptorProto.TYPE_BYTES TYPE_BYTES = descriptor_pb2.FieldDescriptorProto.TYPE_BYTES

View file

@ -7,20 +7,20 @@ REQUIRES = [
"protobuf", # for parsing blobs from the database "protobuf", # for parsing blobs from the database
] ]
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timezone from datetime import datetime, timezone
from pathlib import Path from pathlib import Path
from typing import Any, Iterator, Optional, Sequence from typing import Any
from urllib.parse import quote from urllib.parse import quote
from my.core import datetime_aware, get_files, LazyLogger, Paths, Res from my.core import LazyLogger, Paths, Res, datetime_aware, get_files
from my.core.common import unique_everseen from my.core.common import unique_everseen
from my.core.sqlite import sqlite_connection from my.core.sqlite import sqlite_connection
import my.config
from ._android_protobuf import parse_labeled, parse_list, parse_place from ._android_protobuf import parse_labeled, parse_list, parse_place
import my.config # isort: skip
logger = LazyLogger(__name__) logger = LazyLogger(__name__)
@ -59,8 +59,8 @@ class Place:
updated_at: datetime_aware # TODO double check it's utc? updated_at: datetime_aware # TODO double check it's utc?
title: str title: str
location: Location location: Location
address: Optional[str] address: str | None
note: Optional[str] note: str | None
@property @property
def place_url(self) -> str: def place_url(self) -> str:

View file

@ -2,18 +2,22 @@
Google Takeout exports: browsing history, search/youtube/google play activity Google Takeout exports: browsing history, search/youtube/google play activity
''' '''
from enum import Enum from __future__ import annotations
from my.core import __NOT_HPI_MODULE__ # isort: skip
import re import re
from pathlib import Path from collections.abc import Iterable
from datetime import datetime from datetime import datetime
from enum import Enum
from html.parser import HTMLParser from html.parser import HTMLParser
from typing import List, Optional, Any, Callable, Iterable, Tuple from pathlib import Path
from typing import Any, Callable
from urllib.parse import unquote from urllib.parse import unquote
import pytz import pytz
from ...core.time import abbr_to_timezone from my.core.time import abbr_to_timezone
# NOTE: https://bugs.python.org/issue22377 %Z doesn't work properly # NOTE: https://bugs.python.org/issue22377 %Z doesn't work properly
_TIME_FORMATS = [ _TIME_FORMATS = [
@ -36,7 +40,7 @@ def parse_dt(s: str) -> datetime:
s, tzabbr = s.rsplit(maxsplit=1) s, tzabbr = s.rsplit(maxsplit=1)
tz = abbr_to_timezone(tzabbr) tz = abbr_to_timezone(tzabbr)
dt: Optional[datetime] = None dt: datetime | None = None
for fmt in _TIME_FORMATS: for fmt in _TIME_FORMATS:
try: try:
dt = datetime.strptime(s, fmt) dt = datetime.strptime(s, fmt)
@ -73,7 +77,7 @@ class State(Enum):
Url = str Url = str
Title = str Title = str
Parsed = Tuple[datetime, Url, Title] Parsed = tuple[datetime, Url, Title]
Callback = Callable[[datetime, Url, Title], None] Callback = Callable[[datetime, Url, Title], None]
@ -83,9 +87,9 @@ class TakeoutHTMLParser(HTMLParser):
super().__init__() super().__init__()
self.state: State = State.OUTSIDE self.state: State = State.OUTSIDE
self.title_parts: List[str] = [] self.title_parts: list[str] = []
self.title: Optional[str] = None self.title: str | None = None
self.url: Optional[str] = None self.url: str | None = None
self.callback = callback self.callback = callback
@ -148,7 +152,7 @@ class TakeoutHTMLParser(HTMLParser):
def read_html(tpath: Path, file: str) -> Iterable[Parsed]: def read_html(tpath: Path, file: str) -> Iterable[Parsed]:
results: List[Parsed] = [] results: list[Parsed] = []
def cb(dt: datetime, url: Url, title: Title) -> None: def cb(dt: datetime, url: Url, title: Title) -> None:
results.append((dt, url, title)) results.append((dt, url, title))
parser = TakeoutHTMLParser(callback=cb) parser = TakeoutHTMLParser(callback=cb)
@ -156,5 +160,3 @@ def read_html(tpath: Path, file: str) -> Iterable[Parsed]:
data = fo.read() data = fo.read()
parser.feed(data) parser.feed(data)
return results return results
from ...core import __NOT_HPI_MODULE__

View file

@ -1,7 +1,7 @@
""" """
Parses Google Takeout using [[https://github.com/seanbreckenridge/google_takeout_parser][google_takeout_parser]] Parses Google Takeout using [[https://github.com/purarue/google_takeout_parser][google_takeout_parser]]
See [[https://github.com/seanbreckenridge/google_takeout_parser][google_takeout_parser]] for more information See [[https://github.com/purarue/google_takeout_parser][google_takeout_parser]] for more information
about how to export and organize your takeouts about how to export and organize your takeouts
If the DISABLE_TAKEOUT_CACHE environment variable is set, this won't cache individual If the DISABLE_TAKEOUT_CACHE environment variable is set, this won't cache individual
@ -12,28 +12,31 @@ zip files of the exports, which are temporarily unpacked while creating
the cachew cache the cachew cache
""" """
REQUIRES = ["git+https://github.com/seanbreckenridge/google_takeout_parser"] REQUIRES = ["git+https://github.com/purarue/google_takeout_parser"]
import os
from collections.abc import Sequence
from contextlib import ExitStack from contextlib import ExitStack
from dataclasses import dataclass from dataclasses import dataclass
import os
from typing import List, Sequence, cast
from pathlib import Path from pathlib import Path
from my.core import make_config, stat, Stats, get_files, Paths, make_logger from typing import cast
from google_takeout_parser.parse_html.html_time_utils import ABBR_TIMEZONES
from my.core import Paths, Stats, get_files, make_config, make_logger, stat
from my.core.cachew import mcachew from my.core.cachew import mcachew
from my.core.error import ErrorPolicy from my.core.error import ErrorPolicy
from my.core.structure import match_structure from my.core.structure import match_structure
from my.core.time import user_forced from my.core.time import user_forced
from google_takeout_parser.parse_html.html_time_utils import ABBR_TIMEZONES
ABBR_TIMEZONES.extend(user_forced()) ABBR_TIMEZONES.extend(user_forced())
import google_takeout_parser import google_takeout_parser
from google_takeout_parser.path_dispatch import TakeoutParser from google_takeout_parser.merge import CacheResults, GoogleEventSet
from google_takeout_parser.merge import GoogleEventSet, CacheResults
from google_takeout_parser.models import BaseEvent from google_takeout_parser.models import BaseEvent
from google_takeout_parser.path_dispatch import TakeoutParser
# see https://github.com/seanbreckenridge/dotfiles/blob/master/.config/my/my/config/__init__.py for an example # see https://github.com/purarue/dotfiles/blob/master/.config/my/my/config/__init__.py for an example
from my.config import google as user_config from my.config import google as user_config
@ -56,6 +59,7 @@ logger = make_logger(__name__, level="warning")
# patch the takeout parser logger to match the computed loglevel # patch the takeout parser logger to match the computed loglevel
from google_takeout_parser.log import setup as setup_takeout_logger from google_takeout_parser.log import setup as setup_takeout_logger
setup_takeout_logger(logger.level) setup_takeout_logger(logger.level)
@ -83,7 +87,7 @@ except ImportError:
google_takeout_version = str(getattr(google_takeout_parser, '__version__', 'unknown')) google_takeout_version = str(getattr(google_takeout_parser, '__version__', 'unknown'))
def _cachew_depends_on() -> List[str]: def _cachew_depends_on() -> list[str]:
exports = sorted([str(p) for p in inputs()]) exports = sorted([str(p) for p in inputs()])
# add google takeout parser pip version to hash, so this re-creates on breaking changes # add google takeout parser pip version to hash, so this re-creates on breaking changes
exports.insert(0, f"google_takeout_version: {google_takeout_version}") exports.insert(0, f"google_takeout_version: {google_takeout_version}")
@ -119,7 +123,7 @@ def events(disable_takeout_cache: bool = DISABLE_TAKEOUT_CACHE) -> CacheResults:
else: else:
results = exit_stack.enter_context(match_structure(path, expected=EXPECTED, partial=True)) results = exit_stack.enter_context(match_structure(path, expected=EXPECTED, partial=True))
for m in results: for m in results:
# e.g. /home/sean/data/google_takeout/Takeout-1634932457.zip") -> 'Takeout-1634932457' # e.g. /home/username/data/google_takeout/Takeout-1634932457.zip") -> 'Takeout-1634932457'
# means that zipped takeouts have nice filenames from cachew # means that zipped takeouts have nice filenames from cachew
cw_id, _, _ = path.name.rpartition(".") cw_id, _, _ = path.name.rpartition(".")
# each takeout result is cached as well, in individual databases per-type # each takeout result is cached as well, in individual databases per-type

View file

@ -2,13 +2,17 @@
Module for locating and accessing [[https://takeout.google.com][Google Takeout]] data Module for locating and accessing [[https://takeout.google.com][Google Takeout]] data
''' '''
from __future__ import annotations
from my.core import __NOT_HPI_MODULE__ # isort: skip
from abc import abstractmethod from abc import abstractmethod
from collections.abc import Iterable
from pathlib import Path from pathlib import Path
from typing import Iterable, Optional, Protocol
from more_itertools import last from more_itertools import last
from my.core import __NOT_HPI_MODULE__, Paths, get_files from my.core import Paths, get_files
class config: class config:
@ -33,7 +37,7 @@ def make_config() -> config:
return combined_config() return combined_config()
def get_takeouts(*, path: Optional[str] = None) -> Iterable[Path]: def get_takeouts(*, path: str | None = None) -> Iterable[Path]:
""" """
Sometimes google splits takeout into multiple archives, so we need to detect the ones that contain the path we need Sometimes google splits takeout into multiple archives, so we need to detect the ones that contain the path we need
""" """
@ -45,7 +49,7 @@ def get_takeouts(*, path: Optional[str] = None) -> Iterable[Path]:
yield takeout yield takeout
def get_last_takeout(*, path: Optional[str] = None) -> Optional[Path]: def get_last_takeout(*, path: str | None = None) -> Path | None:
return last(get_takeouts(path=path), default=None) return last(get_takeouts(path=path), default=None)

View file

@ -3,14 +3,14 @@ Hackernews data via Dogsheep [[hacker-news-to-sqlite][https://github.com/dogshee
""" """
from __future__ import annotations from __future__ import annotations
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timezone from datetime import datetime, timezone
from pathlib import Path from pathlib import Path
from typing import Iterator, Sequence, Optional
from my.core import get_files, Paths, Res, datetime_aware
from my.core.sqlite import sqlite_connection
import my.config import my.config
from my.core import Paths, Res, datetime_aware, get_files
from my.core.sqlite import sqlite_connection
from .common import hackernews_link from .common import hackernews_link
@ -33,9 +33,9 @@ class Item:
id: str id: str
type: str type: str
created: datetime_aware # checked and it's utc created: datetime_aware # checked and it's utc
title: Optional[str] # only present for Story title: str | None # only present for Story
text_html: Optional[str] # should be present for Comment and might for Story text_html: str | None # should be present for Comment and might for Story
url: Optional[str] # might be present for Story url: str | None # might be present for Story
# todo process 'deleted'? fields? # todo process 'deleted'? fields?
# todo process 'parent'? # todo process 'parent'?

View file

@ -1,17 +1,22 @@
""" """
[[https://play.google.com/store/apps/details?id=com.simon.harmonichackernews][Harmonic]] app for Hackernews [[https://play.google.com/store/apps/details?id=com.simon.harmonichackernews][Harmonic]] app for Hackernews
""" """
from __future__ import annotations
REQUIRES = ['lxml', 'orjson'] REQUIRES = ['lxml', 'orjson']
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timezone from datetime import datetime, timezone
import orjson
from pathlib import Path from pathlib import Path
from typing import Any, Dict, Iterator, List, Optional, Sequence, TypedDict, cast from typing import Any, TypedDict, cast
import orjson
from lxml import etree from lxml import etree
from more_itertools import one from more_itertools import one
import my.config
from my.core import ( from my.core import (
Paths, Paths,
Res, Res,
@ -22,8 +27,10 @@ from my.core import (
stat, stat,
) )
from my.core.common import unique_everseen from my.core.common import unique_everseen
import my.config
from .common import hackernews_link, SavedBase from .common import SavedBase, hackernews_link
import my.config # isort: skip
logger = make_logger(__name__) logger = make_logger(__name__)
@ -43,7 +50,7 @@ class Cached(TypedDict):
created_at_i: int created_at_i: int
id: str id: str
points: int points: int
test: Optional[str] test: str | None
title: str title: str
type: str # TODO Literal['story', 'comment']? comments are only in 'children' field tho type: str # TODO Literal['story', 'comment']? comments are only in 'children' field tho
url: str url: str
@ -94,16 +101,16 @@ def _saved() -> Iterator[Res[Saved]]:
# TODO defensive for each item! # TODO defensive for each item!
tr = etree.parse(path) tr = etree.parse(path)
res = one(cast(List[Any], tr.xpath(f'//*[@name="{_PREFIX}_CACHED_STORIES_STRINGS"]'))) res = one(cast(list[Any], tr.xpath(f'//*[@name="{_PREFIX}_CACHED_STORIES_STRINGS"]')))
cached_ids = [x.text.split('-')[0] for x in res] cached_ids = [x.text.split('-')[0] for x in res]
cached: Dict[str, Cached] = {} cached: dict[str, Cached] = {}
for sid in cached_ids: for sid in cached_ids:
res = one(cast(List[Any], tr.xpath(f'//*[@name="{_PREFIX}_CACHED_STORY{sid}"]'))) res = one(cast(list[Any], tr.xpath(f'//*[@name="{_PREFIX}_CACHED_STORY{sid}"]')))
j = orjson.loads(res.text) j = orjson.loads(res.text)
cached[sid] = j cached[sid] = j
res = one(cast(List[Any], tr.xpath(f'//*[@name="{_PREFIX}_BOOKMARKS"]'))) res = one(cast(list[Any], tr.xpath(f'//*[@name="{_PREFIX}_BOOKMARKS"]')))
for x in res.text.split('-'): for x in res.text.split('-'):
ids, item_timestamp = x.split('q') ids, item_timestamp = x.split('q')
# not sure if timestamp is any useful? # not sure if timestamp is any useful?

View file

@ -1,19 +1,20 @@
""" """
[[https://play.google.com/store/apps/details?id=io.github.hidroh.materialistic][Materialistic]] app for Hackernews [[https://play.google.com/store/apps/details?id=io.github.hidroh.materialistic][Materialistic]] app for Hackernews
""" """
from collections.abc import Iterator, Sequence
from datetime import datetime, timezone from datetime import datetime, timezone
from pathlib import Path from pathlib import Path
from typing import Any, Dict, Iterator, NamedTuple, Sequence from typing import Any, NamedTuple
from more_itertools import unique_everseen from more_itertools import unique_everseen
from my.core import get_files, datetime_aware, make_logger from my.core import datetime_aware, get_files, make_logger
from my.core.sqlite import sqlite_connection from my.core.sqlite import sqlite_connection
from my.config import materialistic as config # todo migrate config to my.hackernews.materialistic
from .common import hackernews_link from .common import hackernews_link
# todo migrate config to my.hackernews.materialistic
from my.config import materialistic as config # isort: skip
logger = make_logger(__name__) logger = make_logger(__name__)
@ -22,7 +23,7 @@ def inputs() -> Sequence[Path]:
return get_files(config.export_path) return get_files(config.export_path)
Row = Dict[str, Any] Row = dict[str, Any]
class Saved(NamedTuple): class Saved(NamedTuple):

View file

@ -4,20 +4,22 @@
REQUIRES = [ REQUIRES = [
'git+https://github.com/karlicoss/hypexport', 'git+https://github.com/karlicoss/hypexport',
] ]
from collections.abc import Iterator, Sequence
from dataclasses import dataclass from dataclasses import dataclass
from pathlib import Path from pathlib import Path
from typing import Iterator, Sequence, TYPE_CHECKING from typing import TYPE_CHECKING
from my.core import ( from my.core import (
get_files,
stat,
Paths, Paths,
Res, Res,
Stats, Stats,
get_files,
stat,
) )
from my.core.cfg import make_config from my.core.cfg import make_config
from my.core.hpi_compat import always_supports_sequence from my.core.hpi_compat import always_supports_sequence
import my.config
import my.config # isort: skip
@dataclass @dataclass

Some files were not shown because too many files have changed in this diff Show more