Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workfiles tool: Fix work with anatomy templates #237

Merged
merged 2 commits into from
Mar 25, 2024
Merged

Workfiles tool: Fix work with anatomy templates #237

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28db94f
fix work with templates in workfiles tool
iLLiCiTiT Mar 25, 2024
e8d3e56
added some docstrings and comments
iLLiCiTiT Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 71 additions & 17 deletions client/ayon_core/tools/workfiles/models/workfiles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,14 @@


class CommentMatcher(object):
"""Use anatomy and work file data to parse comments from filenames"""
"""Use anatomy and work file data to parse comments from filenames.

Args:
extensions (set[str]): Set of extensions.
file_template (AnatomyStringTemplate): File template.
data (dict[str, Any]): Data to fill the template with.

"""
def __init__(self, extensions, file_template, data):
self.fname_regex = None

Expand Down Expand Up @@ -199,6 +206,22 @@ def _get_template_key(self, fill_data):
def _get_last_workfile_version(
self, workdir, file_template, fill_data, extensions
):
"""

Todos:
Validate if logic of this function is correct. It does return
last version + 1 which might be wrong.

Args:
workdir (str): Workdir path.
file_template (str): File template.
fill_data (dict[str, Any]): Fill data.
extensions (set[str]): Extensions.

Returns:
int: Next workfile version.

"""
version = get_last_workfile_with_version(
workdir, file_template, fill_data, extensions
)[1]
Expand All @@ -225,8 +248,21 @@ def _get_comments_from_root(
root,
current_filename,
):
"""Get comments from root directory.

Args:
file_template (AnatomyStringTemplate): File template.
extensions (set[str]): Extensions.
fill_data (dict[str, Any]): Fill data.
root (str): Root directory.
current_filename (str): Current filename.

Returns:
Tuple[list[str], Union[str, None]]: Comment hints and current
comment.

"""
current_comment = None
comment_hints = set()
filenames = []
if root and os.path.exists(root):
for filename in os.listdir(root):
Expand All @@ -239,10 +275,11 @@ def _get_comments_from_root(
filenames.append(filename)

if not filenames:
return comment_hints, current_comment
return [], current_comment

matcher = CommentMatcher(extensions, file_template, fill_data)

comment_hints = set()
for filename in filenames:
comment = matcher.parse_comment(filename)
if comment:
Expand All @@ -259,18 +296,18 @@ def _get_workdir(self, anatomy, template_key, fill_data):
return directory_template.format_strict(fill_data).normalized()

def get_workarea_save_as_data(self, folder_id, task_id):
folder = None
task = None
folder_entity = None
task_entity = None
if folder_id:
folder = self._controller.get_folder_entity(
folder_entity = self._controller.get_folder_entity(
self.project_name, folder_id
)
if task_id:
task = self._controller.get_task_entity(
self.project_name, task_id
)
if folder_entity and task_id:
task_entity = self._controller.get_task_entity(
self.project_name, task_id
)

if not folder or not task:
if not folder_entity or not task_entity:
return {
"template_key": None,
"template_has_version": None,
Expand Down Expand Up @@ -302,10 +339,11 @@ def get_workarea_save_as_data(self, folder_id, task_id):

file_template = anatomy.get_template_item(
"work", template_key, "file"
).template
)
file_template_str = file_template.template

template_has_version = "{version" in file_template
template_has_comment = "{comment" in file_template
template_has_version = "{version" in file_template_str
template_has_comment = "{comment" in file_template_str

comment_hints, comment = self._get_comments_from_root(
file_template,
Expand All @@ -315,7 +353,8 @@ def get_workarea_save_as_data(self, folder_id, task_id):
current_filename,
)
last_version = self._get_last_workfile_version(
workdir, file_template, fill_data, extensions)
workdir, file_template_str, fill_data, extensions
)

return {
"template_key": template_key,
Expand All @@ -338,19 +377,34 @@ def fill_workarea_filepath(
version,
comment,
):
"""Fill workarea filepath based on context.

Args:
folder_id (str): Folder id.
task_id (str): Task id.
extension (str): File extension.
use_last_version (bool): Use last version.
version (int): Version number.
comment (str): Comment.

Returns:
WorkareaFilepathResult: Workarea filepath result.

"""
anatomy = self._controller.project_anatomy
fill_data = self._prepare_fill_data(folder_id, task_id)

template_key = self._get_template_key(fill_data)

workdir = self._get_workdir(anatomy, template_key, fill_data)

file_template = anatomy.get_template_item(
"work", template_key, "file"
).template
)

if use_last_version:
version = self._get_last_workfile_version(
workdir, file_template, fill_data, self._extensions
workdir, file_template.template, fill_data, self._extensions
)
fill_data["version"] = version
fill_data["ext"] = extension.lstrip(".")
Expand Down
Loading