All modules for which code is available
40 |- hermes.common 41 |
- hermes.paperwork 42 |
35 |
91 |
102 |
103 |
104 |
105 |
106 |
107 |
--------------------------------------------------------------------------------
/helpDoc/_build/_build/html/_static/pygments.css:
--------------------------------------------------------------------------------
1 | .highlight .hll { background-color: #ffffcc }
2 | .highlight { background: #eeffcc; }
3 | .highlight .c { color: #408090; font-style: italic } /* Comment */
4 | .highlight .err { border: 1px solid #FF0000 } /* Error */
5 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */
6 | .highlight .o { color: #666666 } /* Operator */
7 | .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
8 | .highlight .cp { color: #007020 } /* Comment.Preproc */
9 | .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
10 | .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
11 | .highlight .gd { color: #A00000 } /* Generic.Deleted */
12 | .highlight .ge { font-style: italic } /* Generic.Emph */
13 | .highlight .gr { color: #FF0000 } /* Generic.Error */
14 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
15 | .highlight .gi { color: #00A000 } /* Generic.Inserted */
16 | .highlight .go { color: #333333 } /* Generic.Output */
17 | .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
18 | .highlight .gs { font-weight: bold } /* Generic.Strong */
19 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
20 | .highlight .gt { color: #0044DD } /* Generic.Traceback */
21 | .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
22 | .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
23 | .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
24 | .highlight .kp { color: #007020 } /* Keyword.Pseudo */
25 | .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
26 | .highlight .kt { color: #902000 } /* Keyword.Type */
27 | .highlight .m { color: #208050 } /* Literal.Number */
28 | .highlight .s { color: #4070a0 } /* Literal.String */
29 | .highlight .na { color: #4070a0 } /* Name.Attribute */
30 | .highlight .nb { color: #007020 } /* Name.Builtin */
31 | .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
32 | .highlight .no { color: #60add5 } /* Name.Constant */
33 | .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
34 | .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
35 | .highlight .ne { color: #007020 } /* Name.Exception */
36 | .highlight .nf { color: #06287e } /* Name.Function */
37 | .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
38 | .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
39 | .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
40 | .highlight .nv { color: #bb60d5 } /* Name.Variable */
41 | .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
42 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */
43 | .highlight .mb { color: #208050 } /* Literal.Number.Bin */
44 | .highlight .mf { color: #208050 } /* Literal.Number.Float */
45 | .highlight .mh { color: #208050 } /* Literal.Number.Hex */
46 | .highlight .mi { color: #208050 } /* Literal.Number.Integer */
47 | .highlight .mo { color: #208050 } /* Literal.Number.Oct */
48 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
49 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */
50 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
51 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */
52 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
53 | .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
54 | .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
55 | .highlight .sx { color: #c65d09 } /* Literal.String.Other */
56 | .highlight .sr { color: #235388 } /* Literal.String.Regex */
57 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */
58 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */
59 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
60 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
61 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
62 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
63 | .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
--------------------------------------------------------------------------------
/helpDoc/_build/_build/html/py-modindex.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
36 |
59 |
89 |
90 |
37 |
58 |
38 |
39 |
57 |
40 |
54 |
55 |
56 | src¶
41 |
42 |
53 | -
43 |
- hermes package
-
44 |
- Submodules 45 |
- hermes.common module 46 |
- hermes.paperwork module 47 |
- hermes.version module 48 |
- Module contents 49 |
51 |
38 |
105 |
113 |
114 |
115 |
116 |
117 |
118 |
--------------------------------------------------------------------------------
/helpDoc/_build/_build/html/index.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
39 |
80 |
103 |
104 |
40 |
79 |
41 |
42 |
43 |
50 |
75 |
76 |
77 |
78 | Python Module Index
44 | 45 |
46 | h
47 |
48 |
49 | | 52 | h | ||
| 56 | |
57 | hermes | 58 | |
| 61 | |
62 | hermes.common | 63 | |
| 66 | |
67 | hermes.paperwork | 68 | |
| 71 | |
72 | hermes.version | 73 | |
36 |
108 |
119 |
120 |
121 |
122 |
123 |
124 |
--------------------------------------------------------------------------------
/helpDoc/_build/_build/html/genindex.html:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
37 |
69 |
106 |
107 |
38 |
68 |
39 |
40 |
67 |
41 |
56 | Welcome to hermes’s documentation!¶
42 |Contents:
43 |
44 |
55 | -
45 |
- hermes package
-
46 |
- Submodules 47 |
- hermes.common module 48 |
- hermes.paperwork module 49 |
- hermes.version module 50 |
- Module contents 51 |
53 |
57 |
64 |
65 |
66 | Indices and tables¶
58 |-
59 |
- Index 60 |
- Module Index 61 |
- Search Page 62 |
36 |
231 |
239 |
240 |
241 |
242 |
243 |
244 |
--------------------------------------------------------------------------------
/helpDoc/_build/make.bat:
--------------------------------------------------------------------------------
1 | @ECHO OFF
2 |
3 | REM Command file for Sphinx documentation
4 |
5 | if "%SPHINXBUILD%" == "" (
6 | set SPHINXBUILD=sphinx-build.exe
7 | )
8 | set BUILDDIR=_build
9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10 | set I18NSPHINXOPTS=%SPHINXOPTS% .
11 | if NOT "%PAPER%" == "" (
12 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13 | set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14 | )
15 |
16 | if "%1" == "" goto help
17 |
18 | if "%1" == "help" (
19 | :help
20 | echo.Please use `make ^
37 |
203 |
229 |
230 |
38 |
202 |
39 |
40 |
41 |
65 |
66 |
81 |
82 |
91 |
92 |
119 |
120 |
129 |
130 |
139 |
140 |
149 |
150 |
177 |
178 |
187 |
188 |
197 |
198 |
199 |
200 |
201 | Index
42 | 43 | 56 |C
57 |
|
64 |
D
67 |
|
74 |
|
80 |
E
83 |
|
90 |
H
93 |
|
108 |
|
118 |
I
121 |
|
128 |
J
131 |
|
138 |
P
141 |
|
148 |
S
151 |
|
166 |
|
176 |
T
179 |
|
186 |
X
189 |
|
196 |
' + _('Hide Search Matches') + '
') 206 | .appendTo($('#searchbox')); 207 | } 208 | }, 209 | 210 | /** 211 | * init the domain index toggle buttons 212 | */ 213 | initIndexTable : function() { 214 | var togglers = $('img.toggler').click(function() { 215 | var src = $(this).attr('src'); 216 | var idnum = $(this).attr('id').substr(7); 217 | $('tr.cg-' + idnum).toggle(); 218 | if (src.substr(-9) == 'minus.png') 219 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 220 | else 221 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 222 | }).css('display', ''); 223 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 224 | togglers.click(); 225 | } 226 | }, 227 | 228 | /** 229 | * helper function to hide the search marks again 230 | */ 231 | hideSearchWords : function() { 232 | $('#searchbox .highlight-link').fadeOut(300); 233 | $('span.highlighted').removeClass('highlighted'); 234 | }, 235 | 236 | /** 237 | * make the url absolute 238 | */ 239 | makeURL : function(relativeURL) { 240 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 241 | }, 242 | 243 | /** 244 | * get the current relative url 245 | */ 246 | getCurrentURL : function() { 247 | var path = document.location.pathname; 248 | var parts = path.split(/\//); 249 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 250 | if (this == '..') 251 | parts.pop(); 252 | }); 253 | var url = parts.join('/'); 254 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 255 | } 256 | }; 257 | 258 | // quick alias for translations 259 | _ = Documentation.gettext; 260 | 261 | $(document).ready(function() { 262 | Documentation.init(); 263 | }); 264 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License - 2.0 2 | 3 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 4 | 5 | 1. Definitions. 6 | 7 | "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. 8 | 9 | "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. 10 | 11 | "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control 12 | with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management 13 | of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial 14 | ownership of such entity. 15 | 16 | "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. 17 | 18 | "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, 19 | and configuration files. 20 | 21 | "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to 22 | compiled object code, generated documentation, and conversions to other media types. 23 | 24 | "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice 25 | that is included in or attached to the work (an example is provided in the Appendix below). 26 | 27 | "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the 28 | editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes 29 | of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, 30 | the Work and Derivative Works thereof. 31 | 32 | "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work 33 | or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual 34 | or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of 35 | electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on 36 | electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for 37 | the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing 38 | by the copyright owner as "Not a Contribution." 39 | 40 | "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and 41 | subsequently incorporated within the Work. 42 | 43 | 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, 44 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, 45 | publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 46 | 47 | 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, 48 | non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, 49 | sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are 50 | necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was 51 | submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work 52 | or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You 53 | under this License for that Work shall terminate as of the date such litigation is filed. 54 | 55 | 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, 56 | and in Source or Object form, provided that You meet the following conditions: 57 | 58 | 1. You must give any other recipients of the Work or Derivative Works a copy of this License; and 59 | 60 | 2. You must cause any modified files to carry prominent notices stating that You changed the files; and 61 | 62 | 3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices 63 | from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and 64 | 65 | 4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a 66 | readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the 67 | Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the 68 | Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever 69 | such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. 70 | You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, 71 | provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to 72 | Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your 73 | modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with 74 | the conditions stated in this License. 75 | 76 | 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You 77 | to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, 78 | nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 79 | 80 | 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except 81 | as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 82 | 83 | 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides 84 | its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, 85 | any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for 86 | determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under 87 | this License. 88 | 89 | 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required 90 | by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, 91 | including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the 92 | use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or 93 | any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 94 | 95 | 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a 96 | fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting 97 | such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree 98 | to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your 99 | accepting any such warranty or additional liability. 100 | 101 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /helpDoc/_build/_build/html/_modules/hermes/common.html: -------------------------------------------------------------------------------- 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 |
36 |
134 |
142 |
143 |
144 |
145 |
146 |
147 |
--------------------------------------------------------------------------------
/helpDoc/_build/_build/html/_static/underscore.js:
--------------------------------------------------------------------------------
1 | // Underscore.js 1.3.1
2 | // (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
3 | // Underscore is freely distributable under the MIT license.
4 | // Portions of Underscore are inspired or borrowed from Prototype,
5 | // Oliver Steele's Functional, and John Resig's Micro-Templating.
6 | // For all details and documentation:
7 | // http://documentcloud.github.com/underscore
8 | (function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
9 | c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
10 | h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
11 | b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e
37 |
107 |
132 |
133 |
38 |
106 |
39 |
40 |
103 |
104 |
105 | Source code for hermes.common
41 | """
42 | Copyright 2015 Esri
43 | Licensed under the Apache License, Version 2.0 (the 'License');
44 | you may not use this file except in compliance with the License.
45 | You may obtain a copy of the License at
46 | http://www.apache.org/licenses/LICENSE-2.0
47 | Unless required by applicable law or agreed to in writing, software
48 | distributed under the License is distributed on an 'AS IS' BASIS,
49 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
50 | See the License for the specific language governing permissions and
51 | limitations under the License.
52 | """
53 |
54 | from __future__ import absolute_import
55 | from __future__ import print_function
56 | import traceback
57 | import sys
58 | import os
59 | __version__ = "1.1.0"
60 |
61 | [docs]def trace():
62 | """
63 | trace finds the line, the filename
64 | and error message and returns it
65 | to the user
66 | """
67 |
68 | tb = sys.exc_info()[2]
69 | info = sys.exc_info()
70 | extracttb = traceback.extract_tb(info[2])
71 | fileName = os.path.basename(extracttb[0][0])
72 | tbinfo = traceback.format_tb(tb)[0]
73 | # script name + line number
74 | line = tbinfo.split(", ")[1]
75 | # Get Python syntax error
76 | #
77 | synerror = traceback.format_exc().splitlines()[-1]
78 | return line, fileName, synerror
79 | #--------------------------------------------------------------------------
80 |
83 | #--------------------------------------------------------------------------
84 | [docs]def safe_unicode(obj, *args):
85 | """ return the unicode representation of obj """
86 | try:
87 | return unicode(obj, *args)
88 | except UnicodeDecodeError:
89 | # obj is byte string
90 | ascii_text = str(obj).encode('string_escape')
91 | return unicode(ascii_text)
92 | #--------------------------------------------------------------------------
93 | [docs]def safe_str(obj):
94 | """ return the byte string representation of obj """
95 | try:
96 | return str(obj)
97 | except UnicodeEncodeError:
98 | # obj is unicode
99 | return unicode(obj).encode('unicode_escape')
100 |
101 |
102 | ' + _('Searching') + '
').appendTo(this.out); 301 | this.dots = $('').appendTo(this.title); 302 | this.status = $('').appendTo(this.out); 303 | this.output = $('
36 |
400 |
411 |
412 |
413 |
414 |
415 |
416 |
--------------------------------------------------------------------------------
37 |
355 |
398 |
399 |
38 |
354 |
39 |
40 |
353 |
41 |
350 |
351 |
352 | hermes package¶
42 |
43 |
45 | Submodules¶
44 |
46 |
86 | hermes.common module¶
47 |Copyright 2015 Esri 48 | Licensed under the Apache License, Version 2.0 (the ‘License’); 49 | you may not use this file except in compliance with the License. 50 | You may obtain a copy of the License at
51 |52 |53 |
Unless required by applicable law or agreed to in writing, software 54 | distributed under the License is distributed on an ‘AS IS’ BASIS, 55 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 56 | See the License for the specific language governing permissions and 57 | limitations under the License.
58 |-
59 |
-
60 | exception
hermes.common.HermesErrorHandler[source]¶
61 | Bases:
62 |exceptions.ExceptionError handler for hermes package
63 |
-
66 |
-
67 |
hermes.common.safe_str(obj)[source]¶
68 | return the byte string representation of obj
69 |
87 |
321 | hermes.paperwork module¶
88 |This module contains the working class that does the filing, and managing 89 | of the metadata. Much like Hermes Conrad, it loves to parse, change and 90 | file metadata back and forth between dictionaries and xml. The results is 91 | an easy to use tool where users can script metadata changes without having 92 | to parse the XML in XML format.
93 |-
94 |
- Requires : Python 2.7.x, Python 3.4 95 |
- ArcGIS 10.3.1/ArcGIS 10.4 96 |
Copyright 2015 Esri 98 | Licensed under the Apache License, Version 2.0 (the ‘License’); 99 | you may not use this file except in compliance with the License. 100 | You may obtain a copy of the License at
101 |102 |103 |
Unless required by applicable law or agreed to in writing, software 104 | distributed under the License is distributed on an ‘AS IS’ BASIS, 105 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 106 | See the License for the specific language governing permissions and 107 | limitations under the License.
108 |-
109 |
-
110 | class
hermes.paperwork.Paperwork(dataset)[source]¶
111 | Bases:
112 |objectAllows users to easily create and modify the metadata from the feature 113 | class. The data will be returned as a dictionary object for easy of 114 | use. This means users can modify values and push them back into the 115 | metadata by referencing the key names.
116 |To use, just pass in the path of a feature class or table. The dataset 117 | can be any support ArcGIS format that support metadata.
118 |Usage Reader Example:
119 |124 |123 |>>> fc =r"c: emp\scratch.gdb\states" 120 | >>> pw = Paperwork(dataset=fc) 121 | >>> print pw.convert() 122 |
Usage Update Example (add searchKeys to the metadata):
125 |133 |132 |>>> fc = r"c: emp\scratch.gdb\states" 126 | >>> pw = Paperwork(dataset=fc) 127 | >>> val = pw.convert() 128 | >>> val['metadata']['dataIdInfo']['searchKeys'] = {} 129 | >>> val['metadata']['dataIdInfo']['searchKeys']['keywords'] = ['states', 'USA'] 130 | >>> pw.save(d=val) 131 |
The dictionary results explained:
134 |All attributes begin with a ‘@’ and will be inside the element tag. 135 | All text values will be stated as: #text : <value> 136 | Example:
137 |138 |
148 |<someelement myValue=1>i heart paperwork</someelement> 139 | Results in: 140 | {‘someelement’: { '@myValue‘ : 1,
141 |142 |
146 |143 |
144 |‘#text’ : ‘i heart paperwork’}
145 |}
147 |-
149 |
- Example 2: 150 |
-
151 |
- <someelement myValue=1> 152 |
- <subelement tags=”fish”>my value</subelement> 153 |
</someelement>
155 |
156 | - Results in: 157 |
-
158 |
- {‘someelement’: { '@myValue‘ : 1, 159 |
160 |
166 |-
161 |
- “subelement” : {'@tags‘ : “fish”, 162 |
- ‘#text’ : ‘my value’ 163 | } 164 |
}
167 |
168 |
}
170 |
171 |
-
179 |
-
180 |
dataset¶
181 | get/sets the dataset metadata
182 |
-
185 |
-
186 |
datasetProperties¶
187 | returns a collection of common dataset properties including 188 | information about the workspace. 189 | The return object is a dictionary {}
190 |
-
193 |
-
194 |
exportToXML(outFolder=None, outName=None)[source]¶
195 | Exports a metadata file (.xml) to a save location and a given name. 196 | To get the save changes, call the save() before running the 197 | function.
198 |Example: 199 | >>> fc = r”c: empscratch.gdbstates” 200 | >>> pw = Paperwork(dataset=fc) 201 | >>> val = pw.convert() 202 | >>> val[‘metadata’][‘dataIdInfo’][‘searchKeys’] = {} 203 | >>> val[‘metadata’][‘dataIdInfo’][‘searchKeys’][‘keywords’] = [‘states’, ‘USA’] 204 | >>> pw.save(d=val) 205 | >>> print pw.exportToXML(r”c: empmymetadata”, “system_shell.xml”)
206 |-
207 |
- Inputs: 208 |
-
209 |
- outFolder - optional - is the value provided is not given, then 210 |
- systems temp folder will be used. 211 |
- outName - optional - is the name of the xml file. This can be 212 |
- provided, or created by the system. The file create will be 213 | randomly generated. 214 |
216 | - Output: 217 |
- path to xml file 218 |
-
222 |
-
223 |
importXMLFile(xmlFile)[source]¶
224 | imports an xml metadata file to the target dataset. 225 | Input:
226 |227 |
228 |xmlFile - the xml file to import to the dataset.-
229 |
- Output: 230 |
- outputs the dictionary of the newly imported file. It returns 231 | None if the xml file is not valid or does not exist. 232 |
-
236 |
-
237 |
json¶
238 | returns the object as json from the xml document
239 |
-
242 |
-
243 |
save(d=None)[source]¶
244 | commits the xml changes from the dictionary to the dataset 245 | If d is set to None, then dictionary from convert() will be 246 | used.
247 |-
248 |
- Inputs: 249 |
-
250 |
- d - optional - either None or dictionary to be converted to 251 |
- metdata xml and applied to the dataset. 252 |
254 | - Raises: 255 |
- HermesErrorHandler 256 |
-
260 |
-
261 |
save_location¶
262 | returns the location where the xml file is saved
263 |
-
266 |
-
267 |
setSyncMethod(method='ALWAYS')[source]¶
268 | Automatically updates an ArcGIS item’s metadata with the current 269 | properties of the item. 270 | For example, if the metadata describes the item as having one 271 | projection but the item’s projection has changed since the last 272 | automatic update, the old projection information in the metadata 273 | will be replaced with the new projection information.
274 |By default, metadata is automatically updated when anyone who has 275 | write access to the ArcGIS item views its metadata. Metadata can 276 | also be synchronized by running this tool. The option to turn off 277 | synchronization when you view metadata doesn’t affect how this tool 278 | operates.
279 |-
280 |
- Inputs: 281 |
-
282 |
- method - The type of synchronization that will take place. 283 |
-
284 |
- ALWAYS -Properties of the source item are always added to or 285 |
- updated in its metadata. Metadata will be created if it 286 | doesn’t already exist. This is the deault. 287 |
- ACCESSED -Properties of the source item are added to or updated 288 |
- in its metadata when it is accessed. Metadata will be created 289 | if it doesn’t already exist. 290 |
- CREATED -Metadata will be created and properties of the source 291 |
- item will be added to it if the item doesn’t already have 292 | metadata. 293 |
- NOT_CREATED -Properties of the source item are added to or 294 |
- updated in existing metadata. 295 |
- OVERWRITE -The same as “ALWAYS” except all information that can 296 |
- be recorded automatically in the metadata will be recorded. 297 | Any properties typed in by a person will be replaced with the 298 | item’s actual properties. 299 |
- SELECTIVE -The same as “OVERWRITE” except the title and the 300 |
- content type will not be overwritten with default values for 301 | the item. Used when metadata is upgraded to the ArcGIS 10.x 302 | metadata format. 303 |
305 | - Ouput: 306 |
- dataset path 307 |
309 |
-
313 |
-
314 |
xmlfile¶
315 | gets the temporary xml file path
316 |
322 |
335 | hermes.version module¶
323 |Copyright 2015 Esri 324 | Licensed under the Apache License, Version 2.0 (the ‘License’); 325 | you may not use this file except in compliance with the License. 326 | You may obtain a copy of the License at
327 |328 |329 |
Unless required by applicable law or agreed to in writing, software 330 | distributed under the License is distributed on an ‘AS IS’ BASIS, 331 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 332 | See the License for the specific language governing permissions and 333 | limitations under the License.
334 |
336 |
349 | Module contents¶
337 |Copyright 2015 Esri 338 | Licensed under the Apache License, Version 2.0 (the ‘License’); 339 | you may not use this file except in compliance with the License. 340 | You may obtain a copy of the License at
341 |342 |343 |
Unless required by applicable law or agreed to in writing, software 344 | distributed under the License is distributed on an ‘AS IS’ BASIS, 345 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 346 | See the License for the specific language governing permissions and 347 | limitations under the License.
348 |