Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

add docstrings for get_custom_namespace function

Browse source
This commit is contained in:
Thomas Fricard 2023-04-07 14:52:58 +02:00
parent 163e01542c
commit 265fec770b
1 changed files with 20 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
openpype/hosts/maya/api/plugin.py
View file

@ -85,6 +85,25 @@ def get_reference_node_parents(ref):
def get_custom_namespace(custom_namespace):
"""Return unique namespace.
The input namespace can contain a single group
of '#' number tokens to indicate where the namespace's
unique index should go. The amount of tokens defines
the zero padding of the number, e.g ### turns into 001.
Warning: Note that a namespace will always be
prefixed with a _ if it starts with a digit
Example:
>>> get_custom_namespace("myspace_##_")
# myspace_01_
>>> get_custom_namespace("##_myspace")
# _01_myspace
>>> get_custom_namespace("myspace##")
# myspace01
"""
split = re.split("([#]+)", custom_namespace, 1)
if len(split) == 3:
@ -92,7 +111,7 @@ def get_custom_namespace(custom_namespace):
padding = "%0{}d".format(len(padding))
else:
base = split[0]
padding = "%02d"
padding = "%02d" # default padding
suffix = ""
return lib.unique_namespace(