Skip to content

Commit ab12e04

Browse files
committed
REFACT: modifierS.py-->modifer.py
1 parent 88fb1fd commit ab12e04

File tree

17 files changed

+29
-29
lines changed

17 files changed

+29
-29
lines changed

docs/source/arch.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -351,11 +351,11 @@ Architecture
351351
function arguments, `provides` and *needs* can be annotated as "ghost" `sideffects`
352352
or assigned an `accessor` to work with `hierarchical data`.
353353

354-
.. include:: ../../graphtik/modifiers.py
354+
.. include:: ../../graphtik/modifier.py
355355
:start-after: .. diacritics-start
356356
:end-before: .. diacritics-end
357357

358-
See :mod:`graphtik.modifiers` module.
358+
See :mod:`graphtik.modifier` module.
359359

360360
optionals
361361
A `needs` only `modifier` for a `inputs` that do not hinder `operation` execution
@@ -378,7 +378,7 @@ Architecture
378378
- the :func:`.varargs` annotates *iterable* values and all its items are appended
379379
in the ``*args`` one-by-one.
380380

381-
.. include:: ../../graphtik/modifiers.py
381+
.. include:: ../../graphtik/modifier.py
382382
:start-after: .. varargs-mistake-start
383383
:end-before: .. varargs-mistake-end
384384

docs/source/operations.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,19 +156,19 @@ Declarations of *needs* and *provides* is affected by :term:`modifier`\s like
156156

157157
Map inputs to different function arguments
158158
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
159-
.. autofunction:: graphtik.modifiers.keyword
159+
.. autofunction:: graphtik.modifier.keyword
160160
:noindex:
161161

162162
Operations may execute with missing inputs
163163
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
164-
.. autofunction:: graphtik.modifiers.optional
164+
.. autofunction:: graphtik.modifier.optional
165165
:noindex:
166166

167167
Calling functions with varargs (``*args``)
168168
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169-
.. autofunction:: graphtik.modifiers.vararg
169+
.. autofunction:: graphtik.modifier.vararg
170170
:noindex:
171-
.. autofunction:: graphtik.modifiers.varargs
171+
.. autofunction:: graphtik.modifier.varargs
172172
:noindex:
173173

174174

@@ -179,7 +179,7 @@ Aliased `provides`
179179
Sometimes, you need to interface functions & operations where they name a
180180
:term:`dependency` differently.
181181
This is doable without introducing "pipe-through" interface operation, either
182-
by annotating certain `needs` with :func:`.keyword` `modifiers` (above), or
182+
by annotating certain `needs` with :func:`.keyword` *modifier* (above), or
183183
by :term:`alias`\sing certain `provides` to different names:
184184

185185
>>> op = operation(str,

docs/source/pipelines.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -244,12 +244,12 @@ Advanced pipelines
244244

245245
Depending on sideffects
246246
^^^^^^^^^^^^^^^^^^^^^^^
247-
.. autofunction:: graphtik.modifiers.sfx
247+
.. autofunction:: graphtik.modifier.sfx
248248
:noindex:
249249

250250
Modifying existing values in solutions
251251
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
252-
.. autofunction:: graphtik.modifiers.sfxed
252+
.. autofunction:: graphtik.modifier.sfxed
253253
:noindex:
254254

255255
Resilience when operations fail (*endurance*)
@@ -398,7 +398,7 @@ First, let's build the single day's workflow, without any nesting:
398398
>>> from graphtik import NO_RESULT, sfxed
399399
>>> from graphtik.base import RenArgs # type hints for autocompletion.
400400
>>> from graphtik.execution import task_context
401-
>>> from graphtik.modifiers import dep_renamed
401+
>>> from graphtik.modifier import dep_renamed
402402

403403
>>> todos = sfxed("backlog", "todos")
404404
>>> @operation(name="wake up",

docs/source/reference.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ API Reference
77
graphtik
88
graphtik.op
99
graphtik.pipeline
10-
graphtik.modifiers
10+
graphtik.modifier
1111
graphtik.network
1212
graphtik.execution
1313
graphtik.plot
@@ -36,10 +36,10 @@ Module: `pipeline`
3636
:private-members:
3737
:special-members:
3838

39-
Module: `modifiers`
39+
Module: `modifier`
4040
====================
4141

42-
.. automodule:: graphtik.modifiers
42+
.. automodule:: graphtik.modifier
4343
:members:
4444
:private-members:
4545
:special-members:

graphtik/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313

1414
from .base import AbortedException, IncompleteExecutionError, MultiValueError
15-
from .modifiers import (
15+
from .modifier import (
1616
accessor,
1717
jsonp,
1818
keyword,

graphtik/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -682,7 +682,7 @@ def plot(
682682
**Examples:**
683683
684684
>>> from graphtik import compose, operation
685-
>>> from graphtik.modifiers import optional
685+
>>> from graphtik.modifier import optional
686686
>>> from operator import add
687687
688688
>>> pipeline = compose("pipeline",
@@ -902,7 +902,7 @@ def _rename_graph_names(
902902
- if a `renamer` was neither dict nor callable
903903
- if a `renamer` dict contained a non-string value,
904904
"""
905-
from .modifiers import dep_renamed
905+
from .modifier import dep_renamed
906906

907907
def with_errors_logged(fn, ren_args: RenArgs) -> str:
908908
"""Wrap `fn` to log its errors without touching ex, for debug aid."""

graphtik/execution.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
is_reschedule_operations,
3838
is_skip_evictions,
3939
)
40-
from .modifiers import (
40+
from .modifier import (
4141
acc_contains,
4242
acc_delitem,
4343
acc_getitem,
File renamed without changes.

graphtik/network.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
from .base import Items, Operation, PlotArgs, Plottable, astuple, jetsam
2828
from .config import is_debug, is_skip_evictions
29-
from .modifiers import (
29+
from .modifier import (
3030
modifier_withset,
3131
dep_renamed,
3232
dep_stripped,

graphtik/op.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Define :term:`operation` & :term:`dependency` and match/zip inputs/outputs during :term:`execution`.
55
66
.. note::
7-
This module (along with :mod:`.modifiers` & :mod:`.pipeline`) is what client code needs
7+
This module (along with :mod:`.modifier` & :mod:`.pipeline`) is what client code needs
88
to define pipelines *on import time* without incurring a heavy price
99
(<5ms on a 2019 fast PC)
1010
"""
@@ -41,7 +41,7 @@
4141
func_name,
4242
jetsam,
4343
)
44-
from .modifiers import (
44+
from .modifier import (
4545
dep_renamed,
4646
dep_singularized,
4747
dep_stripped,

0 commit comments

Comments
 (0)