Package: nomenclate
Online Documentation (ReadTheDocs)Contents1Synopsis1.1Concept Definitions1.2Features2Installation3Usage3.1Python Package Usage3.2YAML Configuration File Rules4Version Support5Attribution1SynopsisNomenclate is a tool which creates persistent objects that can be used to generate strings that follow naming
conventions that you designate.
There are sets of current naming conventions (format strings) that can be replaced or extended following certain rules
for creation. You can add arbitrary tokens as needed and register token filtering of your own designation.There is a full set of YAML defined suffix/side substitution strings which gets created in~/.nomenclate.yml.  This is where you can customize your configuration.1.1Concept Definitionstoken: A component of the format string which is a meaningful symbol/definition pair that will be filtered by
a grammar of regular expressions.
A simplified representation could be token=value wherein the token (as found in the format string) will be resolved
to the value as is adheres to the token’s syntax/grammar rulesformat string: A string that represents a series of tokens separated with arbitrary delimiters.e.g. -side_location_nameDecoratorVar_childtype_purpose_typeNote: Nomenclate automatically supports camelCasing the tokens to separate them as a natural delimiter.For a review of parsing/composition look here1.2FeaturesApplies a naming convention with arbitrary syntax/grammar to the formatting of string tokensTop down parsing of format string given token-specific grammar rule classes that are extensiblePersistent state object instancesUp to date with online help docsUser-customizable YAML/human-readable config fileEasy object property or dictionary state manipulationCross-Python compatible: Tested and working with Python 3.6, 3.7 and 3.8Cross-Platform compatible: Works under Linux, Mac OS ,Windows environmentsFull module/class documentationSensible token value entry/conversion (likeside='left'with automatic token syntax replacement)2InstallationWindows, etc.A universal installation method (that works on Windows, Mac OS X, Linux, …, and always provides the latest version) is to usepip:$pipinstallNomenclate$poetryaddNomenclate(Ifpipinstallation fails for some reason, you can tryeasy_install nomenclateas a fallback.)3Usage3.1Python Package UsageUse this tool via package level functionsimportnomenclate# Create empty name objectnomenclate_empty=nomenclate.Nom()# At any time you can query the state of the nomenclate object through the state property>>>nomenclate_empty.state{'name':'','childtype':'','location':'','var':'','type':'','side':'','decorator':'','purpose':''}# You can also create a nomenclate with initialized kwargsnomenclate_init_kwargs=nomenclate.Nom(name='test',type='group')# Your Nomenclate object has now been initialized and all of the default token set have been added based on# The default format_string property from the `~/.nomenclate.yml` config file# default: side_location_nameDecoratorVar_childtype_purpose_type>>>nomenclate_init_kwargs.state{'name':'test','childtype':'','location':'','var':'','type':'group','side':'','decorator':'','purpose':''}# Feel free to manipulate each token's value on a property basis>>>nomenclate_init_kwargs.location='rear'# Now that you're all set up you can use the get method to obtain a string representation of your conventionalized output:>>>nomenclate_init_kwargs.get()'rr_test_GRP'# As you'll notice both tokens group and location have been composed following the replacements that can be found in the config YAML file.  This way things like "left" just need to be entered as "left" and then based on the yaml will replace automatically with anything you want.  Finally you don't need to enter things like "L" and worry about it later on!# The format string will automate the process of hot swapping naming formats allows any string to be input.>>>nomenclate_init_kwargs.format'side_location_nameDecoratorVar_childtype_purpose_type'>>>nomenclate_init_kwargs.format='name_type'>>>nomenclate_init_kwargs.state{name:'test',type='group'}# You can enter static text that will always be present in the name by surrounding with parenthesis# For now they only support alphanumeric characters.>>>nomenclate_init_kwargs.format='side_location_nameDecoratorVar_(static.text)childtype_purpose_type'>>>nomenclate_init_kwargs.name='test'>>>nomenclate_init_kwargs.location='rear'>>>nomenclate_init_kwargs.type='group''rr_test_staticText_GRP'# Now entering all these values by properties is fun and all, however there is a convenience function that can digest dictionaries>>>test_nom=nomenclate.Nom()>>>test_nom.merge_serialization({'name':'test','location':'rear','type':'group'})>>>test_nom.get()# As you might have guessed, using state and merge_serialization you can pass naming values from instance to instance (as you can see __eq__ has been defined for Nomenclate instances):>>>nom_a=nomenclate.Nom(name='test',location='rear')>>>nom_b=nomenclate.Nom()>>>nom_b==nom_aFalse>>>nom_b.merge_serialization(nom_a.state)>>>nom_b==nom_aTrue# Optionally you can just pass the nomenclate object itself>>>nom_b.token_dict.reset()# Internal function to be made into a public method later...>>>nom_b==nom_aFalse>>>nom_b.merge_serialization(nom_a)>>>nom_b==nom_aTrue3.2YAML Configuration File RulesSo far the suffixes is a look up dictionary for Maya objects, however I will be adding support for more later.To properly enter a naming format string:Enter all tokens you want to use with descriptive value that naming token’s label e.g:nameand place it where you want it in order in the formatting string you set.
If you want something to space out or separate the names just input whatever separator
you want to use like_or.and it will keep those as delimiters.name_side_typeAdditionall if you want them camel cased for example name and type:side_nameTypeand it will automatically camelcase your for whatever you input for the given token values.In the config YAML file (~/.nomenclate.yml) define your format under the headernaming_formatswith a sub-section name you think is appropriate (the following example is optionally nested under “node”):naming_formats:node:your_format:name_sidePurpose_typeIf you want a static string to always be present in a format string just enclose it with parenthesis (for now only alphanumeric characters are accepted), for example a version:(v)versionin format string:side_name_(v)version_(static_text_example)Example:If version is 3 and your version padding config is set to 2
will evaluate to:v02Further version/var/date specific token notes:There are 3 naming tokens with specific formatting functions that will give you customized results.  You can designate multiple fields for added granularity by adding a number after e.g. var1, var2var:this depends on var in the config being set to upper or lowera: returns a character based on position in alphabet, if you go over it starts aa -> az -> ba -> bz etc.A: returns a character based on position in alphabet, if you go over it starts AA -> AZ -> BA -> BZ etc.version:Will return a string number based on the version_padding config settingdate:Will return a date as a string based on a datetime module formatted string
that the user will input or default to YYYY-MM-DDPlease specify whichever separators (or lack of) you want to override the default behavior just modify the configThe full list of options can be found here:Datetime DocumentationIf you need any custom token value conversion functions you can specify them by inheriting fromnomenclate.core.rendering.RenderBaseand implementing its render function like so:importnomenclateclassRenderCustom(nomenclate.core.rendering.RenderBase):token='custom'defrender(cls,value,token,nomenclate_object,**kwargs):""" Always prepend "meh"

        :param value: str, the un-parsed/formatted token value
        :param token: str, the name of the token in question
        :param nomenclate_object: nomenclate.Nom, the nomenclate instance (for checking attribute values/config settings)
        :return: str, the final syntax adhering token value
        """return'meh'+valueOtherwise, unless you specify an options list for a specific naming token in the custom renderer
it will just replace the text with whatever you set that naming token to
on the nomenclate object.  The options lists will be used as a filter for the
naming token validity or as a look up table for UIs and if you specify
different lengths after it. It will use the first in the list unless
otherwise specified in the overall_config section under “<naming_token>_length”
If there is no abbreviation list afterwards then just write it as a list with -4Version SupportCurrently this package supports Python 2.7, 3.5 and 3.65AttributionWPZOOM Developer Icon Set by WPZOOMLicenseSource- Designed by David Ferreira.Icon made byiconauthfrom www.flaticon.com