CoolPlot 1.2.0__tar.gz → 1.3.0__tar.gz

{coolplot-1.2.0/src/CoolPlot.egg-info → coolplot-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CoolPlot
-Version: 1.2.0
+Version: 1.3.0
 Summary: Thermodynamic property diagrams with CoolProp as data source.
 Author-email: Jorrit Wronski <coolplot@jorrit.org>
 License: MIT License 
@@ -42,6 +42,9 @@ Provides-Extra: test
 Requires-Dist: pytest>=7; extra == "test"
 Requires-Dist: matplotlib>=3.8; extra == "test"
 Requires-Dist: plotly>=5.22; extra == "test"
+Provides-Extra: typing
+Requires-Dist: mypy>=2.4; extra == "typing"
+Requires-Dist: matplotlib>=3.8; extra == "typing"
 Dynamic: license-file
 
 

{coolplot-1.2.0 → coolplot-1.3.0}/pyproject.toml

@@ -36,6 +36,8 @@ plotly = ["plotly>=5.22"]
 # PDF and images from the plotly backend; kaleido also needs Chrome
 images = ["plotly>=5.22", "kaleido>=1.0"]
 test = ["pytest>=7", "matplotlib>=3.8", "plotly>=5.22"]
+# Type checking: tests/test_typing.py runs mypy (skipped without it)
+typing = ["mypy>=2.4", "matplotlib>=3.8"]
 
 [project.urls]
 Homepage = "https://github.com/CoolProp/CoolPlot"
@@ -47,8 +49,32 @@ version = {attr = "coolplot.__version__.__version__"}
 where = ["src"]
 
 [tool.setuptools.package-data]
+"coolplot" = ["py.typed"]   # the package ships its type annotations (PEP 561)
 "coolplot.render" = ["static/*.js"]
 
+[tool.mypy]
+# The package ships its annotations (src/coolplot/py.typed); tests/test_typing.py
+# runs mypy with this configuration over the package and over the typing checks
+# in tests/typing. Unannotated functions are checked too.
+files = ["src/coolplot"]
+python_version = "3.11"
+check_untyped_defs = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+strict_equality = true
+
+# The modules applications work with are fully annotated, and stay so. More
+# modules join this list during 1.x (docs/contributing/typing.md).
+[[tool.mypy.overrides]]
+module = ["coolplot", "coolplot.chart", "coolplot.diagram", "coolplot.psychrometric", "coolplot.export"]
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+
+# Imported only when installed; none of them ships type information
+[[tool.mypy.overrides]]
+module = ["plotly", "plotly.*", "choreographer.*", "kaleido", "kaleido.*", "coolplot_core"]
+ignore_missing_imports = true
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 markers = [

{coolplot-1.2.0 → coolplot-1.3.0/src/CoolPlot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CoolPlot
-Version: 1.2.0
+Version: 1.3.0
 Summary: Thermodynamic property diagrams with CoolProp as data source.
 Author-email: Jorrit Wronski <coolplot@jorrit.org>
 License: MIT License 
@@ -42,6 +42,9 @@ Provides-Extra: test
 Requires-Dist: pytest>=7; extra == "test"
 Requires-Dist: matplotlib>=3.8; extra == "test"
 Requires-Dist: plotly>=5.22; extra == "test"
+Provides-Extra: typing
+Requires-Dist: mypy>=2.4; extra == "typing"
+Requires-Dist: matplotlib>=3.8; extra == "typing"
 Dynamic: license-file
 
 

{coolplot-1.2.0 → coolplot-1.3.0}/src/CoolPlot.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ src/coolplot/diagram.py
 src/coolplot/export.py
 src/coolplot/interaction.py
 src/coolplot/psychrometric.py
+src/coolplot/py.typed
 src/coolplot/scene.py
 src/coolplot/compose/__init__.py
 src/coolplot/compose/branding.py
@@ -100,5 +101,6 @@ tests/test_scene_render.py
 tests/test_spec.py
 tests/test_style.py
 tests/test_thermo.py
+tests/test_typing.py
 tests/test_web.py
 tests/test_web_server.py

{coolplot-1.2.0 → coolplot-1.3.0}/src/CoolPlot.egg-info/requires.txt

@@ -15,3 +15,7 @@ plotly>=5.22
 pytest>=7
 matplotlib>=3.8
 plotly>=5.22
+
+[typing]
+mypy>=2.4
+matplotlib>=3.8

coolplot-1.3.0/src/coolplot/__init__.py

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+"""CoolPlot: thermodynamic property diagrams with CoolProp as data source.
+
+The package is organised in layers; each may only use the layers listed
+before it (see docs/contributing/architecture.md, section 4):
+
+* ``core``: quantities and units, plain data.
+* ``style``: style values and themes.
+* ``scene``: the backend-neutral description of a plot.
+* ``spec``: what the user asks for (fluid, diagram, settings) as data.
+* ``thermo``: all property calculations, in SI units; the only layer that
+  imports CoolProp.
+* ``engine``: which curves are needed, computing and caching them.
+* ``compose``: computed curves plus spec and settings become a scene.
+* ``render``: backends that draw a scene; ``render.mpl`` is the only module
+  that imports matplotlib.
+* ``chart``: :class:`Chart`, the facade users work with;
+  :class:`PropertyDiagram` and :class:`PsychrometricChart` are its two
+  constructors.
+
+See docs/how_to/themes.md for themes and docs/contributing/writing_a_backend.md for writing a new
+backend.
+"""
+from typing import TYPE_CHECKING, Any
+
+from .__version__ import __version__  # noqa: F401
+
+if TYPE_CHECKING:
+    # The same names as in _LAZY below, imported for type checkers only, so
+    # that they see the real classes and functions behind the lazy loading
+    # (tests/test_typing.py checks that the two lists agree). "X as X" marks
+    # a name as part of the package's API for checkers in strict mode.
+    from .chart import Chart as Chart
+    from .core.cycle import Cycle as Cycle, StateInput as StateInput
+    from .core.diagram_type import DiagramType as DiagramType
+    from .core.errors import PropertyError as PropertyError
+    from .core.implementation import native_mode as native_mode, set_native_mode as set_native_mode
+    from .core.limits import Region as Region, Relative as Relative, TpLimits as TpLimits
+    from .core.state import StatePoint as StatePoint
+    from .core.units import (ENGINEERING as ENGINEERING, IP as IP, KSI as KSI, SI as SI, Unit as Unit,
+                             UnitSystem as UnitSystem)
+    from .diagram import PropertyDiagram as PropertyDiagram
+    from .engine import Engine as Engine
+    from .export import save_pdf as save_pdf
+    from .psychrometric import PsychrometricChart as PsychrometricChart
+    from .scene import Scene as Scene
+    from .spec import (BrandingSettings as BrandingSettings, CalcSettings as CalcSettings, CycleSpec as CycleSpec,
+                       DiagramSpec as DiagramSpec, FluidSpec as FluidSpec, HumidAirSpec as HumidAirSpec,
+                       IsolineSet as IsolineSet, LabelSettings as LabelSettings, PageSettings as PageSettings,
+                       ProcessSpec as ProcessSpec, Settings as Settings)
+    from .style.theme import Theme as Theme, get_theme as get_theme
+    from .style.values import (AxesStyle as AxesStyle, Font as Font, LegendStyle as LegendStyle,
+                               LineStyle as LineStyle, MarkerStyle as MarkerStyle, TextStyle as TextStyle)
+    from .thermo import Fluid as Fluid, process_path as process_path, state_point as state_point
+
+# The names below are loaded on first access (PEP 562). Importing a light
+# module such as coolplot.scene therefore does not pull in CoolProp.
+_LAZY = {
+    "Chart": ".chart",
+    "PropertyDiagram": ".diagram",
+    "PsychrometricChart": ".psychrometric",
+    "HumidAirSpec": ".spec",
+    "save_pdf": ".export",
+    "Cycle": ".core.cycle",
+    "CycleSpec": ".spec",
+    "StateInput": ".core.cycle",
+    "DiagramSpec": ".spec",
+    "FluidSpec": ".spec",
+    "IsolineSet": ".spec",
+    "ProcessSpec": ".spec",
+    "Settings": ".spec",
+    "CalcSettings": ".spec",
+    "LabelSettings": ".spec",
+    "PageSettings": ".spec",
+    "BrandingSettings": ".spec",
+    "Engine": ".engine",
+    "Fluid": ".thermo",
+    "DiagramType": ".core.diagram_type",
+    "TpLimits": ".core.limits",
+    "Relative": ".core.limits",
+    "Region": ".core.limits",
+    "StatePoint": ".core.state",
+    "state_point": ".thermo",
+    "process_path": ".thermo",
+    "Theme": ".style.theme",
+    "get_theme": ".style.theme",
+    "LineStyle": ".style.values",
+    "MarkerStyle": ".style.values",
+    "TextStyle": ".style.values",
+    "Font": ".style.values",
+    "AxesStyle": ".style.values",
+    "LegendStyle": ".style.values",
+    "Scene": ".scene",
+    "UnitSystem": ".core.units",
+    "Unit": ".core.units",
+    "SI": ".core.units",
+    "KSI": ".core.units",
+    "ENGINEERING": ".core.units",
+    "IP": ".core.units",
+    "PropertyError": ".core.errors",
+    "native_mode": ".core.implementation",
+    "set_native_mode": ".core.implementation",
+}
+
+__all__ = ["__version__"] + sorted(_LAZY)
+
+
+if not TYPE_CHECKING:
+    # Hidden from type checkers: for them a module with __getattr__ has every
+    # name, and a misspelt one would pass unnoticed. They read the imports above.
+    def __getattr__(name: str) -> Any:
+        if name == "EUR":   # the old name of ENGINEERING, warns until 2.0 (see core.units)
+            from .core.units import _old_eur
+            return _old_eur(2)
+        if name in _LAZY:
+            import importlib
+            module = importlib.import_module(_LAZY[name], __name__)
+            return getattr(module, name)
+        raise AttributeError("module 'coolplot' has no attribute '{0}'".format(name))

{coolplot-1.2.0 → coolplot-1.3.0}/src/coolplot/__version__.py

@@ -1,4 +1,4 @@
 # CoolPlot version information
-VERSION = (1, 2, 0, '')
+VERSION = (1, 3, 0, '')
 
 __version__ = '.'.join(map(str, VERSION[:3])) + ''.join(VERSION[3:])