Skip to content
This repository was archived by the owner on Dec 11, 2024. It is now read-only.

Commit ea42944

Browse files
yarnabrinayarnabrina
authored
Enhancements (#29)
* restructure package * regenerated stubs * regenerated docs * added intersphinx link for standard library
1 parent 5bf919b commit ea42944

37 files changed

Lines changed: 490 additions & 269 deletions

‎docs/source/conf.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"sphinx.ext.autodoc",
1717
"sphinx.ext.coverage",
1818
"sphinx.ext.doctest",
19+
"sphinx.ext.intersphinx",
1920
"sphinx.ext.napoleon",
2021
"sphinx.ext.todo",
2122
"sphinx.ext.viewcode",
@@ -52,6 +53,8 @@
5253
autodoc_typehints_description_target = "documented"
5354
autodoc_typehints_format = "fully-qualified"
5455

56+
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
57+
5558
napoleon_google_docstring = False
5659
napoleon_numpy_docstring = True
5760
napoleon_include_init_with_doc = False

docs/source/package_name_to_import_with.calculator_sub_package.operations_module.rst renamed to docs/source/package_name_to_import_with.calculator_sub_package.basics.assumptions.inverses_module.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package\_name\_to\_import\_with.calculator\_sub\_package.operations\_module module
2-
==================================================================================
1+
package\_name\_to\_import\_with.calculator\_sub\_package.basics.assumptions.inverses\_module module
2+
===================================================================================================
33

4-
.. automodule:: package_name_to_import_with.calculator_sub_package.operations_module
4+
.. automodule:: package_name_to_import_with.calculator_sub_package.basics.assumptions.inverses_module
55
:members:
66
:undoc-members:
77
:show-inheritance:

docs/source/package_name_to_import_with.calculator_sub_package.utility_module.rst renamed to docs/source/package_name_to_import_with.calculator_sub_package.basics.assumptions.operations_module.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package\_name\_to\_import\_with.calculator\_sub\_package.utility\_module module
2-
===============================================================================
1+
package\_name\_to\_import\_with.calculator\_sub\_package.basics.assumptions.operations\_module module
2+
=====================================================================================================
33

4-
.. automodule:: package_name_to_import_with.calculator_sub_package.utility_module
4+
.. automodule:: package_name_to_import_with.calculator_sub_package.basics.assumptions.operations_module
55
:members:
66
:undoc-members:
77
:show-inheritance:

‎docs/source/package_name_to_import_with.calculator_sub_package.basics.assumptions.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
package\_name\_to\_import\_with.calculator\_sub\_package.basics.assumptions package
2+
===================================================================================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
:maxdepth: 3
9+
10+
package_name_to_import_with.calculator_sub_package.basics.assumptions.inverses_module
11+
package_name_to_import_with.calculator_sub_package.basics.assumptions.operations_module
12+
13+
Module contents
14+
---------------
15+
16+
.. automodule:: package_name_to_import_with.calculator_sub_package.basics.assumptions
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:

‎docs/source/package_name_to_import_with.calculator_sub_package.basics.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package\_name\_to\_import\_with.calculator\_sub\_package.basics package
2+
=======================================================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 3
9+
10+
package_name_to_import_with.calculator_sub_package.basics.assumptions
11+
12+
Submodules
13+
----------
14+
15+
.. toctree::
16+
:maxdepth: 3
17+
18+
package_name_to_import_with.calculator_sub_package.basics.utility_module
19+
20+
Module contents
21+
---------------
22+
23+
.. automodule:: package_name_to_import_with.calculator_sub_package.basics
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

docs/source/package_name_to_import_with.calculator_sub_package.inverses_module.rst renamed to docs/source/package_name_to_import_with.calculator_sub_package.basics.utility_module.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package\_name\_to\_import\_with.calculator\_sub\_package.inverses\_module module
2-
================================================================================
1+
package\_name\_to\_import\_with.calculator\_sub\_package.basics.utility\_module module
2+
======================================================================================
33

4-
.. automodule:: package_name_to_import_with.calculator_sub_package.inverses_module
4+
.. automodule:: package_name_to_import_with.calculator_sub_package.basics.utility_module
55
:members:
66
:undoc-members:
77
:show-inheritance:

‎docs/source/package_name_to_import_with.calculator_sub_package.rst‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
package\_name\_to\_import\_with.calculator\_sub\_package package
22
================================================================
33

4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 3
9+
10+
package_name_to_import_with.calculator_sub_package.basics
11+
412
Submodules
513
----------
614

715
.. toctree::
816
:maxdepth: 3
917

10-
package_name_to_import_with.calculator_sub_package.inverses_module
11-
package_name_to_import_with.calculator_sub_package.operations_module
12-
package_name_to_import_with.calculator_sub_package.utility_module
1318
package_name_to_import_with.calculator_sub_package.wrapper_module
1419

1520
Module contents

‎src/module_that_can_invoke_gui_from_cli.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ def define_gui_layout() -> list[list[pydantic.InstanceOf[PySimpleGUI.Element]]]:
2424
[PySimpleGUI.Text("Enter first number"), PySimpleGUI.Input(key=FIRST_NUMBER_INPUT)],
2525
[
2626
PySimpleGUI.Text("Enter operator"),
27-
PySimpleGUI.OptionMenu(["+", "-", "*", "/"], key=OPERATOR_INPUT),
27+
PySimpleGUI.OptionMenu(
28+
package_name_to_import_with.calculator_sub_package.ArithmeticOperator,
29+
key=OPERATOR_INPUT,
30+
),
2831
],
2932
[PySimpleGUI.Text("Enter second number"), PySimpleGUI.Input(key=SECOND_NUMBER_INPUT)],
3033
[PySimpleGUI.Button(button_text="Submit")],

‎src/package_name_to_import_with/calculator_sub_package/__init__.py‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,34 @@
1-
"""Expose selected sub-package contents."""
2-
from .inverses_module import get_negative, get_reciprocal
3-
from .operations_module import add_numbers, multiply_numbers
4-
from .utility_module import divide_numbers, subtract_numbers
5-
from .wrapper_module import calculate_results
1+
"""Expose binary operations."""
2+
from .basics import (
3+
IdentityElements,
4+
InverseElements,
5+
add_numbers,
6+
divide_numbers,
7+
get_negative,
8+
get_reciprocal,
9+
multiply_numbers,
10+
subtract_numbers,
11+
)
12+
from .wrapper_module import (
13+
ARITHMETIC_OPERATIONS,
14+
ArithmeticExpression,
15+
ArithmeticOperation,
16+
ArithmeticOperator,
17+
calculate_results,
18+
)
619

720
__all__ = [
21+
"ARITHMETIC_OPERATIONS",
22+
"ArithmeticExpression",
23+
"ArithmeticOperation",
24+
"ArithmeticOperator",
25+
"IdentityElements",
26+
"InverseElements",
27+
"add_numbers",
28+
"calculate_results",
29+
"divide_numbers",
830
"get_negative",
931
"get_reciprocal",
10-
"add_numbers",
1132
"multiply_numbers",
12-
"divide_numbers",
1333
"subtract_numbers",
14-
"calculate_results",
1534
]

‎src/package_name_to_import_with/calculator_sub_package/basics/__init__.py‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
"""Expose standard functionalities."""
2+
from .assumptions import (
3+
IdentityElements,
4+
InverseElements,
5+
add_numbers,
6+
get_negative,
7+
get_reciprocal,
8+
multiply_numbers,
9+
)
10+
from .utility_module import divide_numbers, subtract_numbers
11+
12+
__all__ = [
13+
"IdentityElements",
14+
"InverseElements",
15+
"add_numbers",
16+
"divide_numbers",
17+
"get_negative",
18+
"get_reciprocal",
19+
"multiply_numbers",
20+
"subtract_numbers",
21+
]

0 commit comments

Comments
 (0)