Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
finam
Manage
Activity
Members
Labels
Plan
Issues
31
Issue boards
Milestones
Code
Merge requests
3
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FINAM
finam
Commits
cdb76aba
Commit
cdb76aba
authored
2 years ago
by
Martin Lange
Browse files
Options
Downloads
Patches
Plain Diff
tweak docs of connector-related methods
parent
d6a48a27
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!154
Auto-transfer infos
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
src/finam/sdk/component.py
+10
-5
10 additions, 5 deletions
src/finam/sdk/component.py
src/finam/tools/connect_helper.py
+1
-1
1 addition, 1 deletion
src/finam/tools/connect_helper.py
with
11 additions
and
6 deletions
src/finam/sdk/component.py
+
10
−
5
View file @
cdb76aba
...
...
@@ -205,7 +205,10 @@ class Component(IComponent, Loggable, ABC):
@property
def
connector
(
self
):
"""
The component
'
s ConnectHelper
"""
"""
The component
'
s :class:`.tools.ConnectHelper`.
See also :meth:`.create_connector` and :meth:`.try_connect`.
"""
return
self
.
_connector
def
create_connector
(
...
...
@@ -213,6 +216,8 @@ class Component(IComponent, Loggable, ABC):
):
"""
Initialize the component
'
s :class:`.tools.ConnectHelper`.
See also :meth:`.try_connect`, :attr:`.connector` and :class:`.ConnectHelper` for details.
Parameters
----------
pull_data : arraylike
...
...
@@ -334,17 +339,17 @@ class Component(IComponent, Loggable, ABC):
Sets the component
'
s :attr:`.status` according to success of exchange.
See :class:`.ConnectHelper` for
more
details.
See
also :meth:`.create_connector`, :attr:`.connector` and
:class:`.ConnectHelper` for details.
Parameters
----------
time : datetime.datatime
time for data pulls
exchange_infos : dict
exchange_infos : dict
of [str, Info]
currently or newly available input data infos by input name
push_infos : dict
push_infos : dict
of [str, Info]
currently or newly available output data infos by output name
push_data : dict
push_data : dict
of [str, array-like]
currently or newly available output data by output name
"""
self
.
logger
.
debug
(
"
try connect
"
)
...
...
This diff is collapsed.
Click to expand it.
src/finam/tools/connect_helper.py
+
1
−
1
View file @
cdb76aba
...
...
@@ -71,7 +71,7 @@ class ConnectHelper(Loggable):
Warning:
This class is not intended for direct use!
Use :meth:`.Component
s
.create_connector` and :meth:`.Component
s
.try_connect` instead.
Use :meth:`.Component.create_connector` and :meth:`.Component.try_connect` instead.
Parameters
----------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment