Skip to content

Commit 0f75fa1

Browse files
GDYendellGDYendell
authored
Improve module structure (#275)
1 parent 9d894ef commit 0f75fa1

File tree

112 files changed

+1429
-1249
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+1429
-1249
lines changed

‎docs/conf.py‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,23 +90,24 @@
9090
# Problems in FastCS itself
9191
("py:class", "T"),
9292
("py:class", "AttrIOUpdateCallback"),
93-
("py:class", "fastcs.transport.epics.pva.pvi_tree._PviSignalInfo"),
93+
("py:class", "fastcs.transports.epics.pva.pvi_tree._PviSignalInfo"),
9494
("py:class", "fastcs.logging._logging.LogLevel"),
9595
("py:class", "fastcs.logging._graylog.GraylogEndpoint"),
9696
("py:class", "fastcs.logging._graylog.GraylogStaticFields"),
9797
("py:class", "fastcs.logging._graylog.GraylogEnvFields"),
9898
("py:obj", "fastcs.control_system.build_controller_api"),
99-
("py:obj", "fastcs.transport.epics.util.controller_pv_prefix"),
99+
("py:obj", "fastcs.transports.epics.util.controller_pv_prefix"),
100100
("docutils", "fastcs.demo.controllers.TemperatureControllerSettings"),
101101
# TypeVar without docstrings still give warnings
102-
("py:class", "fastcs.datatypes.T_Numerical"),
103102
("py:class", "strawberry.schema.schema.Schema"),
104103
]
105104
nitpick_ignore_regex = [
106-
("py:class", "fastcs.*.T"),
107-
("py:obj", "fastcs.*.T"),
105+
("py:class", r"fastcs.*.DType_T"),
106+
("py:class", r"fastcs.*.Numeric_T"),
107+
("py:obj", r"fastcs.*.DType_T"),
108108
(r"py:.*", r"fastcs\.demo.*"),
109109
(r"py:.*", r"tickit.*"),
110+
("py:class", r"numpy.*"),
110111
]
111112

112113
suppress_warnings = ["docutils"]
@@ -149,6 +150,7 @@
149150
# docs in the python documentation.
150151
intersphinx_mapping = {
151152
"python": ("https://docs.python.org/3/", None),
153+
"numpy": ("https://numpy.org/doc/stable/", None),
152154
}
153155

154156
# A dictionary of graphviz graph attributes for inheritance diagrams.

‎docs/snippets/dynamic.py‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,20 @@
44

55
from pydantic import BaseModel, ConfigDict, ValidationError
66

7-
from fastcs.attribute_io import AttributeIO
8-
from fastcs.attribute_io_ref import AttributeIORef
9-
from fastcs.attributes import Attribute, AttrR, AttrRW, AttrW
7+
from fastcs.attributes import (
8+
Attribute,
9+
AttributeIO,
10+
AttributeIORef,
11+
AttrR,
12+
AttrRW,
13+
AttrW,
14+
)
1015
from fastcs.connections import IPConnection, IPConnectionSettings
11-
from fastcs.controller import Controller
16+
from fastcs.controllers import Controller
1217
from fastcs.datatypes import Bool, DataType, Float, Int, String
1318
from fastcs.launch import FastCS
14-
from fastcs.transport.epics.ca.transport import EpicsCATransport
15-
from fastcs.transport.epics.options import EpicsIOCOptions
19+
from fastcs.transports.epics import EpicsIOCOptions
20+
from fastcs.transports.epics.ca import EpicsCATransport
1621

1722

1823
class TemperatureControllerParameter(BaseModel):

‎docs/snippets/static01.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from fastcs.controller import Controller
1+
from fastcs.controllers import Controller
22

33

44
class TemperatureController(Controller):

‎docs/snippets/static02.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from fastcs.controller import Controller
1+
from fastcs.controllers import Controller
22
from fastcs.launch import FastCS
33

44

‎docs/snippets/static03.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from fastcs.attributes import AttrR
2-
from fastcs.controller import Controller
2+
from fastcs.controllers import Controller
33
from fastcs.datatypes import String
44
from fastcs.launch import FastCS
55

‎docs/snippets/static04.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
from fastcs.attributes import AttrR
2-
from fastcs.controller import Controller
2+
from fastcs.controllers import Controller
33
from fastcs.datatypes import String
44
from fastcs.launch import FastCS
5-
from fastcs.transport.epics.ca.transport import EpicsCATransport
6-
from fastcs.transport.epics.options import EpicsIOCOptions
5+
from fastcs.transports.epics import EpicsIOCOptions
6+
from fastcs.transports.epics.ca.transport import EpicsCATransport
77

88

99
class TemperatureController(Controller):

‎docs/snippets/static05.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
from pathlib import Path
22

33
from fastcs.attributes import AttrR
4-
from fastcs.controller import Controller
4+
from fastcs.controllers import Controller
55
from fastcs.datatypes import String
66
from fastcs.launch import FastCS
7-
from fastcs.transport.epics.ca.transport import EpicsCATransport
8-
from fastcs.transport.epics.options import EpicsGUIOptions, EpicsIOCOptions
7+
from fastcs.transports.epics import EpicsGUIOptions, EpicsIOCOptions
8+
from fastcs.transports.epics.ca import EpicsCATransport
99

1010

1111
class TemperatureController(Controller):

‎docs/snippets/static06.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
from fastcs.attributes import AttrR
44
from fastcs.connections import IPConnection, IPConnectionSettings
5-
from fastcs.controller import Controller
5+
from fastcs.controllers import Controller
66
from fastcs.datatypes import String
77
from fastcs.launch import FastCS
8-
from fastcs.transport.epics.ca.transport import EpicsCATransport
9-
from fastcs.transport.epics.options import EpicsGUIOptions, EpicsIOCOptions
8+
from fastcs.transports.epics import EpicsGUIOptions, EpicsIOCOptions
9+
from fastcs.transports.epics.ca import EpicsCATransport
1010

1111

1212
class TemperatureController(Controller):

‎docs/snippets/static07.py‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,13 @@
22
from pathlib import Path
33
from typing import TypeVar
44

5-
from fastcs.attribute_io import AttributeIO
6-
from fastcs.attribute_io_ref import AttributeIORef
7-
from fastcs.attributes import AttrR
5+
from fastcs.attributes import AttributeIO, AttributeIORef, AttrR
86
from fastcs.connections import IPConnection, IPConnectionSettings
9-
from fastcs.controller import Controller
7+
from fastcs.controllers import Controller
108
from fastcs.datatypes import String
119
from fastcs.launch import FastCS
12-
from fastcs.transport.epics.ca.transport import EpicsCATransport
13-
from fastcs.transport.epics.options import EpicsGUIOptions, EpicsIOCOptions
10+
from fastcs.transports.epics import EpicsGUIOptions, EpicsIOCOptions
11+
from fastcs.transports.epics.ca import EpicsCATransport
1412

1513
NumberT = TypeVar("NumberT", int, float)
1614

‎docs/snippets/static08.py‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,13 @@
22
from pathlib import Path
33
from typing import TypeVar
44

5-
from fastcs.attribute_io import AttributeIO
6-
from fastcs.attribute_io_ref import AttributeIORef
7-
from fastcs.attributes import AttrR
5+
from fastcs.attributes import AttributeIO, AttributeIORef, AttrR
86
from fastcs.connections import IPConnection, IPConnectionSettings
9-
from fastcs.controller import Controller
7+
from fastcs.controllers import Controller
108
from fastcs.datatypes import Float, String
119
from fastcs.launch import FastCS
12-
from fastcs.transport.epics.ca.transport import EpicsCATransport
13-
from fastcs.transport.epics.options import EpicsGUIOptions, EpicsIOCOptions
10+
from fastcs.transports.epics import EpicsGUIOptions, EpicsIOCOptions
11+
from fastcs.transports.epics.ca import EpicsCATransport
1412

1513
NumberT = TypeVar("NumberT", int, float)
1614

0 commit comments

Comments
 (0)