Skip to content

Commit

Permalink
Merge pull request #329 from sartography/task/remove-deprecated-funct…
Browse files Browse the repository at this point in the history
…ions

remove one deprecated and unused feature
  • Loading branch information
essweine committed May 12, 2023
2 parents 23d54e5 + ca65602 commit 4644f28
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 43 deletions.
2 changes: 1 addition & 1 deletion SpiffWorkflow/bpmn/parser/BpmnParser.py
Expand Up @@ -46,7 +46,7 @@
EventBasedGateway
)
from SpiffWorkflow.bpmn.specs.event_definitions import NoneEventDefinition
from SpiffWorkflow.bpmn.specs.mixins.subworkfow_task import SubWorkflowTask as SubWorkflowTaskMixin
from SpiffWorkflow.bpmn.specs.mixins.subworkflow_task import SubWorkflowTask as SubWorkflowTaskMixin

from .ValidationException import ValidationException
from .ProcessParser import ProcessParser
Expand Down
22 changes: 3 additions & 19 deletions SpiffWorkflow/bpmn/serializer/helpers/spec.py
Expand Up @@ -132,15 +132,15 @@ class TaskSpecConverter(BpmnSpecConverter):
modules of this package; the `camunda`,`dmn`, and `spiff` serialization packages contain other
examples.
"""
def get_default_attributes(self, spec, include_data=False):
def get_default_attributes(self, spec):
"""Extracts the default Spiff attributes from a task spec.
:param spec: the task spec to be converted
Returns:
a dictionary of standard task spec attributes
"""
dct = {
return {
'name': spec.name,
'description': spec.description,
'manual': spec.manual,
Expand All @@ -155,15 +155,6 @@ def get_default_attributes(self, spec, include_data=False):
'data_output_associations': [ self.registry.convert(obj) for obj in spec.data_output_associations ],
'io_specification': self.registry.convert(spec.io_specification),
}
# This stuff is also all defined in the base task spec, but can contain data, so we need
# our data serializer. I think we should try to get this stuff out of the base task spec.
if include_data:
dct['data'] = self.registry.convert(spec.data)
dct['defines'] = self.registry.convert(spec.defines)
dct['pre_assign'] = self.registry.convert(spec.pre_assign)
dct['post_assign'] = self.registry.convert(spec.post_assign)

return dct

def get_join_attributes(self, spec):
"""Extracts attributes for task specs that inherit from `Join`.
Expand Down Expand Up @@ -204,13 +195,12 @@ def get_standard_loop_attributes(self, spec):
'test_before': spec.test_before,
}

def task_spec_from_dict(self, dct, include_data=False):
def task_spec_from_dict(self, dct):
"""
Creates a task spec based on the supplied dictionary. It handles setting the default
task spec attributes as well as attributes added by `BpmnSpecMixin`.
:param dct: the dictionary to create the task spec from
:param include_data: whether or not to include task spec data attributes
Returns:
a restored task spec
Expand All @@ -234,12 +224,6 @@ def task_spec_from_dict(self, dct, include_data=False):
# Ideally I'd fix it in the parser, but I'm afraid of quickly running into a wall there
spec.bpmn_id = bpmn_id

if include_data:
spec.data = self.registry.restore(dct.get('data', {}))
spec.defines = self.registry.restore(dct.get('defines', {}))
spec.pre_assign = self.registry.restore(dct.get('pre_assign', {}))
spec.post_assign = self.registry.restore(dct.get('post_assign', {}))

if isinstance(spec, BpmnSpecMixin):
spec.io_specification = self.registry.restore(dct.pop('io_specification', None))

Expand Down
2 changes: 1 addition & 1 deletion SpiffWorkflow/bpmn/serializer/workflow.py
Expand Up @@ -24,7 +24,7 @@

from SpiffWorkflow.task import Task
from SpiffWorkflow.bpmn.workflow import BpmnMessage, BpmnWorkflow
from SpiffWorkflow.bpmn.specs.mixins.subworkfow_task import SubWorkflowTask
from SpiffWorkflow.bpmn.specs.mixins.subworkflow_task import SubWorkflowTask

from .migration.version_migration import MIGRATIONS
from .helpers.registry import DefaultRegistry
Expand Down
2 changes: 1 addition & 1 deletion SpiffWorkflow/bpmn/specs/defaults.py
Expand Up @@ -35,7 +35,7 @@
SequentialMultiInstanceTask as SequentialMultiInstanceTaskMixin,
)

from .mixins.subworkfow_task import (
from .mixins.subworkflow_task import (
SubWorkflowTask as SubworkflowTaskMixin,
CallActivity as CallActivityMixin,
TransactionSubprocess as TransactionSubprocessMixin,
Expand Down
2 changes: 1 addition & 1 deletion SpiffWorkflow/bpmn/workflow.py
Expand Up @@ -26,7 +26,7 @@

from SpiffWorkflow.bpmn.specs.mixins.events.event_types import CatchingEvent
from SpiffWorkflow.bpmn.specs.mixins.events.start_event import StartEvent
from SpiffWorkflow.bpmn.specs.mixins.subworkfow_task import CallActivity
from SpiffWorkflow.bpmn.specs.mixins.subworkflow_task import CallActivity
from SpiffWorkflow.bpmn.specs.event_definitions import (
MessageEventDefinition,
MultipleEventDefinition,
Expand Down
2 changes: 1 addition & 1 deletion SpiffWorkflow/spiff/specs/defaults.py
Expand Up @@ -24,7 +24,7 @@

from SpiffWorkflow.bpmn.specs.mixins.events.intermediate_event import SendTask, ReceiveTask

from SpiffWorkflow.bpmn.specs.mixins.subworkfow_task import(
from SpiffWorkflow.bpmn.specs.mixins.subworkflow_task import(
SubWorkflowTask as SubWorkflowTaskMixin,
CallActivity as CallActivityMixin,
TransactionSubprocess as TransactionSubprocessMixin,
Expand Down
19 changes: 1 addition & 18 deletions SpiffWorkflow/task.py
Expand Up @@ -104,24 +104,7 @@ class TaskState:
}


class DeprecatedMetaTask(type):
"""
Handle deprecated methods that are now moved to TaskState
"""
TaskNames = {**TaskStateNames, **TaskStateMasks}
TaskStateFromNames = {v: k for k, v in TaskNames.items()}

def __getattribute__(self, item):
if item in DeprecatedMetaTask.TaskNames.values():
warnings.warn(f'Task.{item} is deprecated. '
f'Please use TaskState.{item}',
DeprecationWarning, stacklevel=2)
return DeprecatedMetaTask.TaskStateFromNames[item]
else:
return type.__getattribute__(self, item)


class Task(object, metaclass=DeprecatedMetaTask):
class Task(object):
"""
Used internally for composing a tree that represents the path that
is taken (or predicted) within the workflow.
Expand Down
2 changes: 1 addition & 1 deletion tests/SpiffWorkflow/bpmn/CollaborationTest.py
@@ -1,4 +1,4 @@
from SpiffWorkflow.bpmn.specs.mixins.subworkfow_task import CallActivity
from SpiffWorkflow.bpmn.specs.mixins.subworkflow_task import CallActivity
from SpiffWorkflow.bpmn.workflow import BpmnWorkflow
from SpiffWorkflow.task import TaskState

Expand Down

0 comments on commit 4644f28

Please sign in to comment.