General: custom staging dir functionality migration

[jakubjezek001]

Changelog Description

The functionality of the staging directory has exceeded its original purpose of publishing. Considering its increased usage in the creation process, we need to migrate it to a dedicated module within the pipeline parent.

Additional info

• adding functionality to Creator base class
• consistency of naming across all features
• making sure backward compatibility to older names and locations remain in settings and api
• anatomy templates with Staging Dir category

Testing notes:

1. all should be working as it was before

[ynbot]

Task linked: OP-5264 Use custom staging dir function for Nuke creators

[BigRoy]

Not sure about the changes and whether it improves any readability, especially the circular imports (and it being worked around) feels problematic.

What stood out to me is that get_instance_staging_dir does not rely on the custom staging dir info at all nor the other way around. Which makes me wonder how do I actually get the correct staging directory for an instance. I'd have expected that get_instance_staging_dir would've considered also the custom transient dir setting, etc. but it seems that's still up to the implementation to check first whether an instance should have a custom staging dir, and if not.. then use get_instance_staging_dir which seems confusing from the name of that function.

[iLLiCiTiT]

Suggested change

	# deprecated: backward compatibility only
	# TODO: remove in the future
	def get_instance_staging_dir(instance):
	return _get_instance_staging_dir(instance)

[jakubjezek001]

Are you suggesting we don't need to maintain compatibility for this function?

[Minkiu]

How come we are not adding them as optional arguments?

[Minkiu]

Should we be passing the host_name here as well?

[Minkiu]

I think this could be only for both? And then _create_local_staging_diris no longer needed :

 return os.path.normpath(
            tempfile.mkdtemp(
                prefix=prefix,
                suffix=suffix,
                dir=custom_temp_dir
            )
        )

If _create_custom_tempdir returns None, so we don't need to do the conditional check.

[Minkiu]

Here we are assuming all of them are missing, right? But later on I can't see where do we check for missing entities? So it could be that we return an instance with -1 that has entities? i.e. Line 50

[iLLiCiTiT]

We add the comma, so a future PRs which add after or move it does not have to add commit to the line.

[iLLiCiTiT]

This is actually faster and easier to read.

Suggested change

	if not any([asset_name, subset]):
	if not asset_name or not subset:

[iLLiCiTiT]

This has changed recently and requires get_versioning_start from openpype.pipeline.version_start.

[hound]

too many blank lines (2)

[hound]

line too long (84 > 79 characters)