From 8b0f99fd2c119a28dd88f28a126fff6bdca960e0 Mon Sep 17 00:00:00 2001 From: jrobinAV Date: Thu, 3 Oct 2024 20:29:38 +0200 Subject: [PATCH] make the refman works with taipy.common --- taipy/common/__init__.py | 2 ++ taipy/common/config/config.py | 2 +- taipy/core/config/core_section.py | 2 +- taipy/core/config/data_node_config.py | 26 +++++++++++++------------- taipy/gui/_gui_section.py | 4 ++-- 5 files changed, 19 insertions(+), 17 deletions(-) diff --git a/taipy/common/__init__.py b/taipy/common/__init__.py index 4309283dc5..b85c1472a9 100644 --- a/taipy/common/__init__.py +++ b/taipy/common/__init__.py @@ -8,3 +8,5 @@ # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on # an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the # specific language governing permissions and limitations under the License. + +"""Common functionalities for the taipy package.""" diff --git a/taipy/common/config/config.py b/taipy/common/config/config.py index 6b6994352e..e25c069c23 100644 --- a/taipy/common/config/config.py +++ b/taipy/common/config/config.py @@ -58,7 +58,7 @@ def by_two(x: int): The configuration can be done in three ways: Python code, configuration files, or environment variables. All configuration manners are ultimately merged (overriding the previous way) to create a final applied configuration. Please refer to the - [advanced configuration](../../../../../userman/advanced_features/configuration/advanced-config.md) + [advanced configuration](../../../../../../userman/advanced_features/configuration/advanced-config.md) section from the user manual for more details. 2. Attributes and methods to retrieve the configuration values. diff --git a/taipy/core/config/core_section.py b/taipy/core/config/core_section.py index 76611c031a..d3dd61c1ea 100644 --- a/taipy/core/config/core_section.py +++ b/taipy/core/config/core_section.py @@ -408,7 +408,7 @@ def _configure( mode (Optional[str]): Indicates the mode of the version management system. Possible values are *"development"* or *"experiment"*. On Enterprise edition of Taipy, *production* mode is also available. Please refer to the - [Versioning management](../../../../../userman/advanced_features/versioning/index.md) + [Versioning management](../../../../../../userman/advanced_features/versioning/index.md) documentation page for more details. version_number (Optional[str]): The string identifier of the version. In development mode, the version number is ignored. diff --git a/taipy/core/config/data_node_config.py b/taipy/core/config/data_node_config.py index eb61ef1555..78cf5a636e 100644 --- a/taipy/core/config/data_node_config.py +++ b/taipy/core/config/data_node_config.py @@ -417,7 +417,7 @@ def _set_default_configuration( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -478,7 +478,7 @@ def _configure( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -531,7 +531,7 @@ def _configure_csv( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -575,7 +575,7 @@ def _configure_json( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -631,7 +631,7 @@ def _configure_parquet( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -681,7 +681,7 @@ def _configure_excel( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -728,7 +728,7 @@ def _configure_generic( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -769,7 +769,7 @@ def _configure_in_memory( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -806,7 +806,7 @@ def _configure_pickle( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -871,7 +871,7 @@ def _configure_sql_table( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -964,7 +964,7 @@ def _configure_sql( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -1046,7 +1046,7 @@ def _configure_mongo_collection( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. @@ -1110,7 +1110,7 @@ def _configure_s3_object( validity_period (Optional[timedelta]): The duration since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task configuration - [page](../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) + [page](../../../../../../userman/scenario_features/task-orchestration/scenario-config.md#from-task-configurations) for more details). If *validity_period* is set to None, the data node is always up-to-date. **properties (dict[str, any]): A keyworded variable length list of additional arguments. diff --git a/taipy/gui/_gui_section.py b/taipy/gui/_gui_section.py index a54873ee27..05b35dfd95 100644 --- a/taipy/gui/_gui_section.py +++ b/taipy/gui/_gui_section.py @@ -53,13 +53,13 @@ def _configure(**properties) -> "_GuiSection": Parameters: **properties (dict[str, any]): Keyword arguments that configure the behavior of the `Gui^` instances.
Please refer to the gui config section - [page](../../../../../userman/advanced_features/configuration/gui-config.md#configuring-the-gui-instance) + [page](../../../../../../userman/advanced_features/configuration/gui-config.md#configuring-the-gui-instance) of the User Manual for more information on the accepted arguments. Returns: The GUI configuration. - """ + """ # noqa: E501 section = _GuiSection(property_list=list(default_config), **properties) TaipyConfig._register(section) return TaipyConfig.unique_sections[_GuiSection.name]