diff --git a/.buildinfo b/.buildinfo index d7cdbd0..c6519a2 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 384f55ffbb015854ae6b06fa453afffa +config: ef12c9661aa400d86f6229ef89602565 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 35fc0f2..8485218 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree index c81965b..efb9cc8 100644 Binary files a/.doctrees/index.doctree and b/.doctrees/index.doctree differ diff --git a/.doctrees/translator.doctree b/.doctrees/translator.doctree index c1b9416..ebce403 100644 Binary files a/.doctrees/translator.doctree and b/.doctrees/translator.doctree differ diff --git a/_modules/index.html b/_modules/index.html index cdfa4f7..9eb7c46 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -1,55 +1,34 @@ - - - - + - - - - - Overview: module code — tk-framework-aliastranslations v0.2.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - + + + Overview: module code — tk-framework-aliastranslations v0.2.4 documentation + + + + + + + + + + + - - - +
- -
- - -
- - - - - - - - - + + + tk_framework_aliastranslations.translator — tk-framework-aliastranslations v0.2.4 documentation + + + + - - - - - - - - - - - - - - - + + + + + + - - - +
- -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - + + + Index — tk-framework-aliastranslations v0.2.4 documentation + + + + + + + + + + + - - - +
- -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - + + + + The Alias Translations Framework — tk-framework-aliastranslations v0.2.4 documentation + + + + + + + + + + + - - - +
- -
- - -
- - - - - - - - - - + + + Search — tk-framework-aliastranslations v0.2.4 documentation + + + - - - - - - - - - - - - - - - + + + + + + + + + + - - - +
- -
- - -
- - - - - - - - - - - - - + diff --git a/searchindex.js b/searchindex.js index 2064a7d..9612d03 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","translator"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["index.rst","translator.rst"],objects:{"tk_framework_aliastranslations.Translator":{add_extra_param:[1,1,1,""],execute:[1,1,1,""],is_valid:[1,1,1,""],translator_path:[1,2,1,""]},tk_framework_aliastranslations:{Translator:[1,0,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute"},terms:{"class":1,"return":1,"true":1,For:0,accord:1,add:1,add_extra_param:1,all:1,argument:1,attribut:1,avail:1,becaus:1,can:[0,1],catpart:0,check:1,code:0,collect:0,command:[0,1],complet:1,comput:0,constructor:1,contain:0,content:0,convers:1,convert:[0,1],current:1,destination_path:1,differ:[0,1],easi:0,environ:1,exampl:1,execut:[0,1],extra:1,fals:1,file:0,find:1,format:[0,1],have:0,helper:0,here:1,igs:0,insid:1,instal:0,introduct:0,is_valid:1,issu:1,licens:1,line:[0,1],list:1,make:0,name:1,need:1,now:0,onli:[0,1],option:1,order:1,otherwis:1,output_path:1,outsid:1,painless:0,param_nam:1,param_valu:1,paramet:1,path:1,piec:1,pleas:1,possibl:1,python:1,refer:1,requir:0,run:1,simpl:1,some:1,sourc:1,source_path:1,specif:1,stp:0,subprocess:1,thi:0,tk_framework_aliastransl:1,tool:0,translator_path:1,use:1,used:1,valu:1,version:1,wait:1,want:1,wrapper:[0,1],wref:[0,1],you:[0,1]},titles:["The Alias Translations Framework","Alias Translations"],titleterms:{The:0,alia:[0,1],catpart:1,code:1,file:1,framework:0,introduct:1,sampl:1,translat:[0,1],wire:1}}) \ No newline at end of file +Search.setIndex({"docnames": ["index", "translator"], "filenames": ["index.rst", "translator.rst"], "titles": ["The Alias Translations Framework", "Alias Translations"], "terms": {"contain": 0, "collect": 0, "helper": 0, "tool": 0, "make": 0, "easi": 0, "painless": 0, "convert": [0, 1], "file": 0, "differ": [0, 1], "format": [0, 1], "thi": 0, "i": [0, 1], "wrapper": [0, 1], "command": [0, 1], "line": [0, 1], "requir": 0, "you": [0, 1], "have": 0, "instal": 0, "comput": 0, "execut": [0, 1], "code": 0, "For": 0, "now": 0, "can": [0, 1], "onli": [0, 1], "wref": [0, 1], "jt": 0, "catpart": 0, "ig": 0, "stp": 0, "content": 0, "introduct": 0, "In": 1, "order": 1, "need": 1, "us": 1, "class": 1, "here": 1, "simpl": 1, "piec": 1, "an": 1, "source_path": 1, "path": 1, "destination_path": 1, "If": 1, "we": 1, "add": 1, "some": 1, "extra": 1, "attribut": 1, "convers": 1, "exampl": 1, "want": 1, "specif": 1, "version": 1, "To": 1, "find": 1, "list": 1, "all": 1, "avail": 1, "argument": 1, "pleas": 1, "refer": 1, "option": 1, "add_extra_param": 1, "r": 1, "19": 1, "tk_framework_aliastransl": 1, "output_path": 1, "sourc": 1, "python": 1, "run": 1, "insid": 1, "outsid": 1, "becaus": 1, "licens": 1, "issu": 1, "constructor": 1, "paramet": 1, "properti": 1, "translator_path": 1, "param_nam": 1, "param_valu": 1, "name": 1, "valu": 1, "is_valid": 1, "check": 1, "": 1, "possibl": 1, "accord": 1, "current": 1, "environ": 1, "return": 1, "fals": 1, "true": 1, "otherwis": 1, "subprocess": 1, "wait": 1, "complet": 1}, "objects": {"tk_framework_aliastranslations": [[1, 0, 1, "", "Translator"]], "tk_framework_aliastranslations.Translator": [[1, 1, 1, "", "add_extra_param"], [1, 1, 1, "", "execute"], [1, 1, 1, "", "is_valid"], [1, 2, 1, "", "translator_path"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:property"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "property", "Python property"]}, "titleterms": {"The": 0, "alia": [0, 1], "translat": [0, 1], "framework": 0, "introduct": 1, "sampl": 1, "code": 1, "wire": 1, "file": 1, "catpart": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"The Alias Translations Framework": [[0, "the-alias-translations-framework"]], "Alias Translations": [[1, "alias-translations"]], "Introduction": [[1, "introduction"]], "Sample Code: Translate a wire file to a CATPart file": [[1, "sample-code-translate-a-wire-file-to-a-catpart-file"]], "Translator": [[1, "translator"]]}, "indexentries": {"translator (class in tk_framework_aliastranslations)": [[1, "tk_framework_aliastranslations.Translator"]], "add_extra_param() (tk_framework_aliastranslations.translator method)": [[1, "tk_framework_aliastranslations.Translator.add_extra_param"]], "execute() (tk_framework_aliastranslations.translator method)": [[1, "tk_framework_aliastranslations.Translator.execute"]], "is_valid() (tk_framework_aliastranslations.translator method)": [[1, "tk_framework_aliastranslations.Translator.is_valid"]], "translator_path (tk_framework_aliastranslations.translator property)": [[1, "tk_framework_aliastranslations.Translator.translator_path"]]}}) \ No newline at end of file diff --git a/translator.html b/translator.html index dc0ab93..9e04185 100644 --- a/translator.html +++ b/translator.html @@ -1,56 +1,36 @@ - - - - + - - - - - Alias Translations — tk-framework-aliastranslations v0.2.3 documentation - - - - - - - + + + + Alias Translations — tk-framework-aliastranslations v0.2.4 documentation + + + + - - - - - - - - - - - - - - - - - + + + + + + - - - +
- -
- - -
+
+

Translator

+
+
+class tk_framework_aliastranslations.Translator(source_path, output_path)[source]

Python wrapper to run the Alias file translations inside and outside of Alias.

-

Note

-

Because of license issue, only the WREF translation can be run outside of Alias.

+

Note

+

Because of license issue, only the WREF translation can be run outside of Alias.

Class constructor.

- --- - - - -
Parameters:
    -
  • source_path – Path to the file we want to translate
    • -
  • output_path – Path to the translated file
    • +
    +
    Parameters:
    +
      +

    • source_path – Path to the file we want to translate

      • +

    • output_path – Path to the translated file

    -
-
-
-translator_path
+
+
+
+
+property translator_path

Path to the executable used to translate the source file

-
-
-add_extra_param(param_name, param_value)[source]
+
+
+add_extra_param(param_name, param_value)[source]

Add an extra parameter to the translator command line

- --- - - - -
Parameters:
    -
  • param_name – Name of the parameter
    • -
  • param_value – Value of the parameter
    • +
    +
    Parameters:
    +
      +

    • param_name – Name of the parameter

      • +

    • param_value – Value of the parameter

    -
+
+
-
-
-is_valid()[source]
+
+
+is_valid()[source]

Check if it’s possible or not to run the translation according to the current environment

- --- - - - -
Returns:False if it’s not possible to run the translation, True otherwise.
+
+
Returns:
+

False if it’s not possible to run the translation, True otherwise.

+
+
-
-
-execute()[source]
+
+
+execute()[source]

Run the translation command in a subprocess and wait for command to complete.

-
- + + - - - - - - - - - - - - - -