get rid of 'legacy' from variables

This commit is contained in:
Jakub Trllo 2022-10-24 18:15:24 +02:00
parent be54ff4d27
commit 81f7aa5525
3 changed files with 41 additions and 40 deletions

View file

@ -22,7 +22,7 @@ from .creator_plugins import (
Creator,
AutoCreator,
discover_creator_plugins,
discover_legacy_convertor_plugins,
discover_convertor_plugins,
)
UpdateData = collections.namedtuple("UpdateData", ["instance", "changes"])
@ -853,8 +853,8 @@ class CreatedInstance:
self[key] = new_value
class LegacyInstancesItem(object):
"""Item representing convertor for legacy instances.
class ConvertorItem(object):
"""Item representing convertor plugin.
Args:
identifier (str): Identifier of convertor.
@ -949,8 +949,8 @@ class CreateContext:
# Manual creators
self.manual_creators = {}
self.legacy_convertors = {}
self.legacy_items_by_id = {}
self.convertors_plugins = {}
self.convertor_items_by_id = {}
self.publish_discover_result = None
self.publish_plugins_mismatch_targets = []
@ -1032,7 +1032,7 @@ class CreateContext:
with self.bulk_instances_collection():
self.reset_instances()
self.find_legacy_items()
self.find_convertor_items()
self.execute_autocreators()
self.reset_finalization()
@ -1090,7 +1090,7 @@ class CreateContext:
self._reset_publish_plugins(discover_publish_plugins)
self._reset_creator_plugins()
self._reset_legacy_convertor_plugins()
self._reset_convertor_plugins()
def _reset_publish_plugins(self, discover_publish_plugins):
import pyblish.logic
@ -1186,9 +1186,9 @@ class CreateContext:
self.creators = creators
def _reset_legacy_convertor_plugins(self):
legacy_convertors = {}
for convertor_class in discover_legacy_convertor_plugins():
def _reset_convertor_plugins(self):
convertors_plugins = {}
for convertor_class in discover_convertor_plugins():
if inspect.isabstract(convertor_class):
self.log.info(
"Skipping abstract Creator {}".format(str(convertor_class))
@ -1196,16 +1196,16 @@ class CreateContext:
continue
convertor_identifier = convertor_class.identifier
if convertor_identifier in legacy_convertors:
if convertor_identifier in convertors_plugins:
self.log.warning((
"Duplicated Converter identifier. "
"Using first and skipping following"
))
continue
legacy_convertors[convertor_identifier] = convertor_class(self)
convertors_plugins[convertor_identifier] = convertor_class(self)
self.legacy_convertors = legacy_convertors
self.convertors_plugins = convertors_plugins
def reset_context_data(self):
"""Reload context data using host implementation.
@ -1278,13 +1278,13 @@ class CreateContext:
def creator_removed_instance(self, instance):
self._instances_by_id.pop(instance.id, None)
def add_legacy_item(self, convertor_identifier, label):
self.legacy_items_by_id[convertor_identifier] = (
LegacyInstancesItem(convertor_identifier, label)
def add_convertor_item(self, convertor_identifier, label):
self.convertor_items_by_id[convertor_identifier] = ConvertorItem(
convertor_identifier, label
)
def remove_legacy_item(self, convertor_identifier):
self.legacy_items_by_id.pop(convertor_identifier, None)
def remove_convertor_item(self, convertor_identifier):
self.convertor_items_by_id.pop(convertor_identifier, None)
@contextmanager
def bulk_instances_collection(self):
@ -1321,10 +1321,10 @@ class CreateContext:
for creator in self.creators.values():
creator.collect_instances()
def find_legacy_items(self):
self.legacy_items_by_id = {}
def find_convertor_items(self):
self.convertor_items_by_id = {}
for convertor in self.legacy_convertors.values():
for convertor in self.convertors_plugins.values():
try:
convertor.find_instances()
except:
@ -1502,6 +1502,6 @@ class CreateContext:
return self._collection_shared_data
def run_convertor(self, convertor_identifier):
convertor = self.legacy_convertors.get(convertor_identifier)
convertor = self.convertors_plugins.get(convertor_identifier)
if convertor is not None:
convertor.convert()

View file

@ -34,7 +34,7 @@ class CreatorError(Exception):
@six.add_metaclass(ABCMeta)
class LegacyInstanceConvertor(object):
class LegacySubsetConvertor(object):
"""Helper for conversion of instances created using legacy creators.
Conversion from legacy creators would mean to loose legacy instances,
@ -45,10 +45,10 @@ class LegacyInstanceConvertor(object):
Convertor logic should be very simple. Method 'find_instances' is to
look for legacy instances in scene a possibly call
pre-implemented 'add_legacy_item'.
pre-implemented 'add_convertor_item'.
User will have ability to trigger conversion which is executed by calling
'convert' which should call 'remove_legacy_item' when is done.
'convert' which should call 'remove_convertor_item' when is done.
It does make sense to add only one or none legacy item to create context
for convertor as it's not possible to choose which instace are converted
@ -78,7 +78,8 @@ class LegacyInstanceConvertor(object):
def find_instances(self):
"""Look for legacy instances in the scene.
Should call 'add_legacy_item' if there is at least one item.
Should call 'add_convertor_item' if there is at least one instance to
convert.
"""
pass
@ -108,19 +109,19 @@ class LegacyInstanceConvertor(object):
return self._create_context.collection_shared_data
def add_legacy_item(self, label):
def add_convertor_item(self, label):
"""Add item to CreateContext.
Args:
label (str): Label of item which will show in UI.
"""
self._create_context.add_legacy_item(self.identifier, label)
self._create_context.add_convertor_item(self.identifier, label)
def remove_legacy_item(self):
def remove_convertor_item(self):
"""Remove legacy item from create context when conversion finished."""
self._create_context.remove_legacy_item(self.identifier)
self._create_context.remove_convertor_item(self.identifier)
@six.add_metaclass(ABCMeta)
@ -559,8 +560,8 @@ def discover_creator_plugins():
return discover(BaseCreator)
def discover_legacy_convertor_plugins():
return discover(LegacyInstanceConvertor)
def discover_convertor_plugins():
return discover(LegacySubsetConvertor)
def discover_legacy_creator_plugins():
@ -620,8 +621,8 @@ def register_creator_plugin(plugin):
elif issubclass(plugin, LegacyCreator):
register_plugin(LegacyCreator, plugin)
elif issubclass(plugin, LegacyInstanceConvertor):
register_plugin(LegacyInstanceConvertor, plugin)
elif issubclass(plugin, LegacySubsetConvertor):
register_plugin(LegacySubsetConvertor, plugin)
def deregister_creator_plugin(plugin):
@ -631,17 +632,17 @@ def deregister_creator_plugin(plugin):
elif issubclass(plugin, LegacyCreator):
deregister_plugin(LegacyCreator, plugin)
elif issubclass(plugin, LegacyInstanceConvertor):
deregister_plugin(LegacyInstanceConvertor, plugin)
elif issubclass(plugin, LegacySubsetConvertor):
deregister_plugin(LegacySubsetConvertor, plugin)
def register_creator_plugin_path(path):
register_plugin_path(BaseCreator, path)
register_plugin_path(LegacyCreator, path)
register_plugin_path(LegacyInstanceConvertor, path)
register_plugin_path(LegacySubsetConvertor, path)
def deregister_creator_plugin_path(path):
deregister_plugin_path(BaseCreator, path)
deregister_plugin_path(LegacyCreator, path)
deregister_plugin_path(LegacyInstanceConvertor, path)
deregister_plugin_path(LegacySubsetConvertor, path)

View file

@ -1608,7 +1608,7 @@ class PublisherController(BasePublisherController):
@property
def convertor_items(self):
return self._create_context.legacy_items_by_id
return self._create_context.convertor_items_by_id
@property
def _creators(self):
@ -1728,7 +1728,7 @@ class PublisherController(BasePublisherController):
self._create_context.reset_context_data()
with self._create_context.bulk_instances_collection():
self._create_context.reset_instances()
self._create_context.find_legacy_items()
self._create_context.find_convertor_items()
self._create_context.execute_autocreators()
self._resetting_instances = False