Skip to content

Commit 041fe15

Browse files
committed
Update deprecation message
1 parent d4d0258 commit 041fe15

File tree

6 files changed

+30
-7
lines changed

6 files changed

+30
-7
lines changed

fractal_tasks_core/dev/create_manifest.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
from typing_extensions import deprecated
2222

23+
from fractal_tasks_core.dev.deprecation_message import DEPRECATION_MSG_FUN
2324
from fractal_tasks_core.dev.lib_args_schemas import (
2425
create_schema_for_single_task,
2526
)
@@ -32,7 +33,7 @@
3233
ARGS_SCHEMA_VERSION = "pydantic_v2"
3334

3435

35-
@deprecated("Please move to `fractal-task-tools`")
36+
@deprecated(DEPRECATION_MSG_FUN)
3637
def create_manifest(
3738
package: str = "fractal_tasks_core",
3839
authors: Optional[str] = None,
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
DEPRECATION_MSG_FUN = (
2+
"This function is deprecated and will be removed in a future release of "
3+
"`fractal-tasks-core`. Please migrate to `fractal-task-tools` for "
4+
"manifest building and task wrappers. See "
5+
"https://fractal-analytics-platform.github.io/fractal-task-tools/usage/"
6+
"#migrate-from-fractal-tasks-core."
7+
)
8+
9+
10+
DEPRECATION_MSG_CLASS = (
11+
"This class is deprecated and will be removed in a future release of "
12+
"`fractal-tasks-core`. Please migrate to `fractal-task-tools` for "
13+
"manifest building and task wrappers. See "
14+
"https://fractal-analytics-platform.github.io/fractal-task-tools/usage/"
15+
"#migrate-from-fractal-tasks-core."
16+
)

fractal_tasks_core/dev/lib_args_schemas.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
from pydantic._internal._config import ConfigWrapper
2727
from typing_extensions import deprecated
2828

29+
from fractal_tasks_core.dev.deprecation_message import DEPRECATION_MSG_FUN
2930
from fractal_tasks_core.dev.lib_descriptions import (
3031
_get_class_attrs_descriptions,
3132
)
@@ -146,7 +147,7 @@ def _create_schema_for_function(function: Callable) -> _Schema:
146147
return json_schema
147148

148149

149-
@deprecated("Please move to `fractal-task-tools`")
150+
@deprecated(DEPRECATION_MSG_FUN)
150151
def create_schema_for_single_task(
151152
executable: str,
152153
package: Optional[str] = "fractal_tasks_core",

fractal_tasks_core/dev/lib_pydantic_generatejsonschema.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@
1717
from pydantic_core.core_schema import WithDefaultSchema
1818
from typing_extensions import deprecated
1919

20+
from fractal_tasks_core.dev.deprecation_message import DEPRECATION_MSG_CLASS
2021

2122
logger = logging.getLogger("CustomGenerateJsonSchema")
2223

2324

24-
@deprecated("Please move to `fractal-task-tools`")
25+
@deprecated(DEPRECATION_MSG_CLASS)
2526
class CustomGenerateJsonSchema(GenerateJsonSchema):
2627
def get_flattened_anyof(
2728
self, schemas: list[JsonSchemaValue]

fractal_tasks_core/dev/task_models.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
from pydantic import Field
2323
from typing_extensions import deprecated
2424

25+
from fractal_tasks_core.dev.deprecation_message import DEPRECATION_MSG_CLASS
26+
2527

2628
class _BaseTask(BaseModel):
2729
class Config:
@@ -39,7 +41,7 @@ class Config:
3941
docs_info: Optional[str] = None
4042

4143

42-
@deprecated("Please move to `fractal-task-tools`")
44+
@deprecated(DEPRECATION_MSG_CLASS)
4345
class CompoundTask(_BaseTask):
4446
"""
4547
A `CompoundTask` object must include both `executable_init` and
@@ -67,7 +69,7 @@ def meta_parallel(self) -> Optional[dict[str, Any]]:
6769
return self.meta
6870

6971

70-
@deprecated("Please move to `fractal-task-tools`")
72+
@deprecated(DEPRECATION_MSG_CLASS)
7173
class NonParallelTask(_BaseTask):
7274
"""
7375
A `NonParallelTask` object must include the `executable` attribute, and it
@@ -91,7 +93,7 @@ def meta_parallel(self) -> None:
9193
return None
9294

9395

94-
@deprecated("Please move to `fractal-task-tools`")
96+
@deprecated(DEPRECATION_MSG_CLASS)
9597
class ParallelTask(_BaseTask):
9698
"""
9799
A `ParallelTask` object must include the `executable` attribute, and it may

fractal_tasks_core/tasks/_utils.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121

2222
from typing_extensions import deprecated
2323

24+
from fractal_tasks_core.dev.deprecation_message import DEPRECATION_MSG_FUN
25+
2426

2527
class TaskParameterEncoder(JSONEncoder):
2628
"""
@@ -37,7 +39,7 @@ def default(self, value):
3739
return JSONEncoder.default(self, value)
3840

3941

40-
@deprecated("Please move to `fractal-task-tools`")
42+
@deprecated(DEPRECATION_MSG_FUN)
4143
def run_fractal_task(
4244
*,
4345
task_function: Callable,

0 commit comments

Comments
 (0)