maya-cmds-help Documentation

Transcription

1 maya-cmds-help Documentation Release Andres Weber May 28, 2017

2

3 Contents Synopsis Features Installation Windows, etc Usage Bash Python Package Usage Class Documentation Version Support 11 Python Module Index 13 i

4 ii

5 maya-cmds-help Documentation, Release Online Documentation (ReadTheDocs) Contents 1 Maya Command Signature Scraper: For people who just really want to check their maya.cmds signatures 1.1 Synopsis * Features 1.2 Installation * Windows, etc. 1.3 Usage * Bash * Python Package Usage 1.4 Class Documentation 1.5 Version Support Contents 1

6 maya-cmds-help Documentation, Release 2 Contents

7 CHAPTER Synopsis If you re looking into this tool, you re looking for a programmatic way of getting Maya function signatures. The current version of the tool has unfiltered prints as status logs...so that might be a deterrent... I personally built it so that I could compare my maya command calls against kwargs/args Maya expects to reduce errors. Hope you ll find it useful! Once you install you will now have a CLI tool called mayasig Features Caching Up to date with online help docs Temp file generator JSON file output CLI access Dict output 3

8 maya-cmds-help Documentation, Release 4 Chapter Synopsis

9 CHAPTER Installation Windows, etc. A universal installation method (that works on Windows, Mac OS X, Linux,..., and always provides the latest version) is to use pip: # Make sure we have an up-to-date version of pip and setuptools: $ pip install --upgrade pip setuptools $ pip install mayasigscraper-cli (If pip installation fails for some reason, you can try easy_install mayasigscraper-cli as a fallback.) 5

10 maya-cmds-help Documentation, Release 6 Chapter Installation

11 CHAPTER Usage Bash mayasig Usage: mayasig [-m --mayaversion VERSION] [-d --depth DEPTH] (MAYA_CMDS...) mayasig (-h --help) mayasig (--version) Options: -h --help Show this screen. --version Show version. -m VERSION --mayaversion VERSION If you want to override which Maya docs we query (tested with 2015/2016/2017) [default: 2017] -d DEPTH --depth DEPTH The depth verbosity of the return dictionary [default: 1] MAYA_CMDS Maya commands to query/scrape from the help and return signatures for Examples: mayasig group Help: For help using this tool, please open an issue on the Github repository: Python Package Usage Feel free to access from the package instead via the two package-level convenience functions: 7

12 maya-cmds-help Documentation, Release maya_signatures.cache maya_signatures.query In order to access full functionality from the scraper class you can access a package level instance of maya_signatures.commands.scrape.scraper using: maya_signatures.scraper import maya_signatures maya_signatures.query('ls') # Result: # storing args ('ls',) storing kwargs {} # Successfully loaded json data, loading into cache... # Retrieving cached value for input Maya-Tech-Docs/CommandsPython/ls.html # wrote out tmp file C:\Users\andre\dev\maya_signature_builder\scrape.json maya_signatures.scraper.build_command_stub('ls') # Result: def ls(*args, textures=bool, selection=bool, defaultnodes=bool, templated=bool, visible=bool, references=bool, flatten=bool, nodetypes=bool, persistentnodes=bool, intermediateobjects=bool, long=bool, leaf=bool, recursive=bool, objectsonly=bool, lockednodes=bool, cameras=bool, tail=int, absolutename=bool, lights=bool, live=bool, rendersetups=bool, containertype=str, preselecthilite=bool, type=str, containers=bool, shortnames=bool, renderresolutions=bool, head=int, showtype=bool, dependencynodes=bool, orderedselection=bool, renderqualities=bool, readonly=bool, referencednodes=bool, shownamespace=bool, invisible=bool, hilite=bool, untemplated=bool, partitions=bool, ghost=bool, uuid=bool, sets=bool, geometry=bool, assemblies=bool, nointermediate=bool, modified=bool, allpaths=bool, shapes=bool, materials=bool, excludetype=str, planes=bool, exacttype=str, renderglobals=bool, undeletable=bool, dagobjects=bool, transforms=bool): # pass maya_signatures.query('group') # Result: storing args ('group',) storing kwargs {} # Successfully loaded json data, loading into cache... # Could not find key CommandsPython/group.html in cached values...retrieving... # Trying to find command for web page: # group.html # wrote out tmp file C:\Users\andre\dev\maya_signature_builder\scrape.json maya_signatures.scraper.get_command_flags('group') # Result: [('name', 'n'), ('parent', 'p'), ('relative', 'r'), ('useasgroup', 'uag'), ('world', 'w'), ('empty', 'em'), ('absolute', 'a')] 8 Chapter Usage

13 CHAPTER Class Documentation The maya online help command signature scraping command. class maya_signatures.commands.scrape.scrape(*args, **kwargs) Bases: maya_signatures.commands.base.base Class responsible for handling Maya help doc command queries and returns function signatures. BASEURL = build_command_stub(command, shortname=false, combined=false) Build a Python stub for the given command. parameters, types, return:: cache_file Provide the cache file path param command str, valid maya command param shortname bool, whether or not we want to use the shortname of the flags param combined bool, whether we use both short name and long name of flags (will invalidate stub...) return str, Python formatted function stub for the given command parameters, types, return:: return str cached Provide the raw cache with urls as the dictionary keys parameters, types, return:: return dict get_command_flags(command) Return only the flags for the given command. parameters, types, return:: 9

14 maya-cmds-help Documentation, Release param command str, maya command return list(list(str, str)), list of lists of flags in format: [<long name>, <short name>] query(commands) Build URLs then stores all queried commands within the instance. :param commands: list(str) or str, valid maya command(s) :return: None reset_cache() Clear the cache file of contents. parameters, types, return:: return None run() CLI interface command runner. parameters, types, return:: return dict, command signatures dictionary sorted the commands as the keys stored_commands Provide a list of commands that are currently stored. parameters, types, return:: return list 10 Chapter Class Documentation

15 CHAPTER Version Support This package supports the Maya 2015, 2016 and 2017 help docs so far so please be aware. I might back port a couple versions of the maya online help, but this is totally dependent on time. genindex modindex search 11

16 maya-cmds-help Documentation, Release 12 Chapter Version Support

17 Python Module Index m maya_signatures.commands.scrape, 9 13

18 maya-cmds-help Documentation, Release 14 Python Module Index

19 Index B BASEURL (maya_signatures.commands.scrape.scrape attribute), 9 build_command_stub() (maya_signatures.commands.scrape.scrape method), 9 C cache_file (maya_signatures.commands.scrape.scrape attribute), 9 cached (maya_signatures.commands.scrape.scrape attribute), 9 G get_command_flags() (maya_signatures.commands.scrape.scrape method), 9 M maya_signatures.commands.scrape (module), 9 Q query() (maya_signatures.commands.scrape.scrape method), 10 R reset_cache() (maya_signatures.commands.scrape.scrape method), 10 run() (maya_signatures.commands.scrape.scrape method), 10 S Scrape (class in maya_signatures.commands.scrape), 9 stored_commands (maya_signatures.commands.scrape.scrape attribute), 10 15