Tools/uMen deps
From Osipa Entertainment
|
Wiki auto-generated by uMen.py on 2/3/2009. uMen is © 2009 Osipa Entertainment, LLC
uMen_deps.py
uMen_deps is a dependency tracking addition to Osipa Entertainment's uMen.py. The way it works is simple; by searching all MEL scripts for a list of their global procedures, then looking for those names in all other MEL scripts in all uMen script paths.
There is an indexing involved to make the interaction speed near instant, but at a cost - the index file takes some time to create. Luckily, the index file can be updated and doesn't need to be rebuilt from scratch every time. If only 2 files are newer than the index only two files need to be indexed.
To install, be sure uMen_deps is in a valid PYTHON_PATH and copy:
import uMen_deps; uMen_deps.addDependencies
into the Python customScriptUI box in the uMen setup window
Procedures
Global procedures available to be used
uMen_deps_layout
Usage
uMen_deps.uMen_deps_layout() ;
Synopsis
Instructions:
Point the index file at some place where you can rely on it being reasonably stationary ( the more it moves, the more you have to do ground-up rebuilds ). It will default to Your first script root / uMen_indexFile.txt if you do nothing.
You can create a "fresh" index file ( it is a good idea to do that periodically ). To "activate" the "Create Fresh ..." button, press Unlock1 which allows you to then press "Unlock2" which will finally enable the "Create Fresh ..." button. This is just to ensure that if you Create a Fresh Index it was most certainly not an accident.
Return Value
Unknown
getIndexFile
Usage
uMen_deps.getIndexFile() ;
Synopsis
Simple retrieval of the index file name and path
Return Value
Unknown
indexStart
Usage
uMen_deps.indexStart() ;
Synopsis
Does the startup information gathering to write an index file
Return Value
Unknown
updateIndexFile
Usage
uMen_deps.updateIndexFile( False ) ;
uMen_deps.updateIndexFile( delIndexFirst ) ;
Synopsis
Searches for dependencies, creates an index file
Variables
delIndexFirst
| Name | Variable Type | Default value(s) |
| delIndexFirst | bool | False |
- Delete the old index file (start over), or update it
Return Value
Unknown
depFinderUpdateCmd
Usage
uMen_deps.depFinderUpdateCmd( "" ) ;
uMen_deps.depFinderUpdateCmd( file ) ;
Synopsis
Provides a button command for updating the index file
Variables
file
| Name | Variable Type | Default value(s) |
| file | string | "" |
- The file to work with
Return Value
Unknown
dependencyFinder
Usage
uMen_deps.dependencyFinder( "" ) ;
uMen_deps.dependencyFinder( file ) ;
Synopsis
Looks into the index file and pulls out dependencies relevant to the current file
Variables
file
| Name | Variable Type | Default value(s) |
| file | string | "" |
- The file to work with
Return Value
Unknown
uMen_deps_multiWinner
Usage
uMen_deps.uMen_deps_multiWinner( , ) ;
uMen_deps.uMen_deps_multiWinner( uses, usesAll ) ;
Synopsis
If there is more than one file that could be the dependency, this will determine which file is CURRENTLY used. Sourcing another one could mean it would be different the very next time the window is opened
Variables
uses, usesAll
| Name | Variable Type | Default value(s) |
| uses | None | 0 |
- A list of dependencies with full paths, procedures
| usesAll | None | 0 |
- A list of all the dependencies (short names only)
Return Value
Unknown
addDependencies
Usage
uMen_deps.addDependencies( "", "" ) ;
uMen_deps.addDependencies( file, parent ) ;
Synopsis
Digs up dependencies involving this file, and creates a tab in a uMen scriptUI with buttons that will take you to other files' scriptUIs.
Variables
file, parent
| Name | Variable Type | Default value(s) |
| file | string | "" |
- The file to work with
| parent | string | "" |
- The UI to parent the dependency layout to
Return Value
Unknown
Additional Information
Legals
Osipa Entertainment, LLC makes no guarantees or warranties related to download and/or use of any tools, mel and python scripts and plugins.
Although Osipa Entertainment provides some tools, mel and python scripts and plugins for free, it is it is prohibited to remove any of the documentation, copyright notices, and/or any references and links to Osipa Entertainment, LLC.
