src/source/pyams_utils/pyams_utils.rst
branchdoc-dc
changeset 51 5ebe61e3a965
parent 50 6ed429390935
child 66 2643fb0f7bbc
equal deleted inserted replaced
50:6ed429390935 51:5ebe61e3a965
     1 .. _pyams_utils:
     1 .. _pyams_utils:
     2 
     2 
     3 pyams_utils package
     3 \ :mod:`pyams_utils` package
     4 ===================
     4 ============================
     5 
     5 
     6 .. automodule:: pyams_utils
     6 .. automodule:: pyams_utils
     7     :members:
     7     :members:
     8     :undoc-members:
     8     :undoc-members:
     9     :show-inheritance:
     9     :show-inheritance:
    10 
    10 
    11 Submodules
    11 pyams_utils.\ ``adapter``
    12 ++++++++++
    12 -------------------------
    13 
    13 
    14 pyams\_utils\.adapter module
    14 .. automodule:: pyams_utils.adapter
       
    15     :members:
       
    16     :undoc-members:
       
    17     :show-inheritance:
       
    18 
       
    19 pyams_utils.\ ``attr``
       
    20 ----------------------
       
    21 
       
    22 .. automodule:: pyams_utils.attr
       
    23     :members:
       
    24     :undoc-members:
       
    25     :show-inheritance:
       
    26 
       
    27 pyams_utils.\ ``cache``
       
    28 -----------------------
       
    29 
       
    30 .. automodule:: pyams_utils.cache
       
    31     :members:
       
    32     :undoc-members:
       
    33     :show-inheritance:
       
    34 
       
    35 pyams_utils.\ ``container``
       
    36 ---------------------------
       
    37 
       
    38 .. automodule:: pyams_utils.container
       
    39     :members:
       
    40     :undoc-members:
       
    41     :show-inheritance:
       
    42 
       
    43 pyams_utils.\ ``context``
       
    44 -------------------------
       
    45 
       
    46 .. automodule:: pyams_utils.context
       
    47     :members:
       
    48     :undoc-members:
       
    49     :show-inheritance:
       
    50 
       
    51 pyams_utils.\ ``data``
       
    52 ----------------------
       
    53 
       
    54 .. automodule:: pyams_utils.data
       
    55     :members:
       
    56     :undoc-members:
       
    57     :show-inheritance:
       
    58 
       
    59 pyams_utils.\ ``date``
       
    60 ----------------------
       
    61 
       
    62 .. automodule:: pyams_utils.date
       
    63     :members:
       
    64     :undoc-members:
       
    65     :show-inheritance:
       
    66 
       
    67 pyams_utils.\ ``decorator``
       
    68 ---------------------------
       
    69 
       
    70 .. automodule:: pyams_utils.decorator
       
    71     :members:
       
    72     :undoc-members:
       
    73     :show-inheritance:
       
    74 
       
    75 pyams_utils.\ ``dict``
       
    76 ----------------------
       
    77 
       
    78 .. automodule:: pyams_utils.dict
       
    79     :members:
       
    80     :undoc-members:
       
    81     :show-inheritance:
       
    82 
       
    83 pyams_utils.\ ``encoding``
       
    84 --------------------------
       
    85 
       
    86 .. automodule:: pyams_utils.encoding
       
    87     :members:
       
    88     :undoc-members:
       
    89     :show-inheritance:
       
    90 
       
    91 pyams_utils.\ ``fanstatic``
       
    92 ---------------------------
       
    93 
       
    94 .. automodule:: pyams_utils.fanstatic
       
    95     :members:
       
    96     :undoc-members:
       
    97     :show-inheritance:
       
    98 
       
    99 pyams_utils.\ ``html``
       
   100 ----------------------
       
   101 
       
   102 .. automodule:: pyams_utils.html
       
   103     :members:
       
   104     :undoc-members:
       
   105     :show-inheritance:
       
   106 
       
   107 pyams_utils.\ ``i18n``
       
   108 ----------------------
       
   109 
       
   110 .. automodule:: pyams_utils.i18n
       
   111     :members:
       
   112     :undoc-members:
       
   113     :show-inheritance:
       
   114 
       
   115 pyams_utils.\ ``include``
       
   116 -------------------------
       
   117 
       
   118 .. automodule:: pyams_utils.include
       
   119     :members:
       
   120     :undoc-members:
       
   121     :show-inheritance:
       
   122 
       
   123 pyams_utils.\ ``inherit``
       
   124 -------------------------
       
   125 
       
   126 .. automodule:: pyams_utils.inherit
       
   127     :members:
       
   128     :undoc-members:
       
   129     :show-inheritance:
       
   130 
       
   131 pyams_utils.\ ``intids``
       
   132 ------------------------
       
   133 
       
   134 .. automodule:: pyams_utils.intids
       
   135     :members:
       
   136     :undoc-members:
       
   137     :show-inheritance:
       
   138 
       
   139 pyams_utils.\ ``list``
       
   140 ----------------------
       
   141 
       
   142 .. automodule:: pyams_utils.list
       
   143     :members:
       
   144     :undoc-members:
       
   145     :show-inheritance:
       
   146 
       
   147 pyams_utils.\ ``lock``
       
   148 ----------------------
       
   149 
       
   150 .. automodule:: pyams_utils.lock
       
   151     :members:
       
   152     :undoc-members:
       
   153     :show-inheritance:
       
   154 
       
   155 pyams_utils.\ ``progress``
       
   156 --------------------------
       
   157 
       
   158 .. automodule:: pyams_utils.progress
       
   159     :members:
       
   160     :undoc-members:
       
   161     :show-inheritance:
       
   162 
       
   163 pyams_utils.\ ``property``
       
   164 --------------------------
       
   165 
       
   166 .. automodule:: pyams_utils.property
       
   167     :members:
       
   168     :undoc-members:
       
   169     :show-inheritance:
       
   170 
       
   171 pyams_utils.\ ``registry``
       
   172 --------------------------
       
   173 
       
   174 .. automodule:: pyams_utils.registry
       
   175     :members:
       
   176     :undoc-members:
       
   177     :show-inheritance:
       
   178 
       
   179 pyams_utils.\ ``request``
       
   180 -------------------------
       
   181 
       
   182 .. automodule:: pyams_utils.request
       
   183     :members:
       
   184     :undoc-members:
       
   185     :show-inheritance:
       
   186 
       
   187 pyams_utils.\ ``schema``
       
   188 ------------------------
       
   189 
       
   190 .. automodule:: pyams_utils.schema
       
   191     :members:
       
   192     :undoc-members:
       
   193     :show-inheritance:
       
   194 
       
   195 pyams_utils.\ ``session``
       
   196 -------------------------
       
   197 
       
   198 .. automodule:: pyams_utils.session
       
   199     :members:
       
   200     :undoc-members:
       
   201     :show-inheritance:
       
   202 
       
   203 pyams_utils.\ ``site``
       
   204 ----------------------
       
   205 
       
   206 .. automodule:: pyams_utils.site
       
   207     :members:
       
   208     :undoc-members:
       
   209     :show-inheritance:
       
   210 
       
   211 pyams_utils.\ ``size``
       
   212 ----------------------
       
   213 
       
   214 .. automodule:: pyams_utils.size
       
   215     :members:
       
   216     :undoc-members:
       
   217     :show-inheritance:
       
   218 
       
   219 pyams_utils.\ ``tales``
       
   220 -----------------------
       
   221 
       
   222 .. automodule:: pyams_utils.tales
       
   223     :members:
       
   224     :undoc-members:
       
   225     :show-inheritance:
       
   226 
       
   227 pyams_utils.\ ``text``
       
   228 ----------------------
       
   229 
       
   230 .. automodule:: pyams_utils.text
       
   231     :members:
       
   232     :undoc-members:
       
   233     :show-inheritance:
       
   234 
       
   235 pyams_utils.\ ``traversing``
    15 ----------------------------
   236 ----------------------------
    16 
   237 
    17 .. automodule:: pyams_utils.adapter
   238 .. automodule:: pyams_utils.traversing
    18     :members:
   239     :members:
    19     :undoc-members:
   240     :undoc-members:
    20     :show-inheritance:
   241     :show-inheritance:
    21 
   242 
    22 pyams\_utils\.attr module
   243 pyams_utils.\ ``unicode``
    23 -------------------------
   244 -------------------------
    24 
   245 
    25 .. automodule:: pyams_utils.attr
   246 .. automodule:: pyams_utils.unicode
    26     :members:
   247     :members:
    27     :undoc-members:
   248     :undoc-members:
    28     :show-inheritance:
   249     :show-inheritance:
    29 
   250 
    30 pyams\_utils\.cache module
   251 pyams_utils.\ ``url``
    31 --------------------------
   252 ---------------------
    32 
   253 
    33 .. automodule:: pyams_utils.cache
   254 .. automodule:: pyams_utils.url
    34     :members:
   255     :members:
    35     :undoc-members:
   256     :undoc-members:
    36     :show-inheritance:
   257     :show-inheritance:
    37 
   258 
    38 pyams\_utils\.container module
   259 pyams_utils.\ ``vocabulary``
    39 ------------------------------
       
    40 
       
    41 .. automodule:: pyams_utils.container
       
    42     :members:
       
    43     :undoc-members:
       
    44     :show-inheritance:
       
    45 
       
    46 pyams\_utils\.context module
       
    47 ----------------------------
   260 ----------------------------
    48 
   261 
    49 .. automodule:: pyams_utils.context
       
    50     :members:
       
    51     :undoc-members:
       
    52     :show-inheritance:
       
    53 
       
    54 pyams\_utils\.data module
       
    55 -------------------------
       
    56 
       
    57 .. automodule:: pyams_utils.data
       
    58     :members:
       
    59     :undoc-members:
       
    60     :show-inheritance:
       
    61 
       
    62 pyams\_utils\.date module
       
    63 -------------------------
       
    64 
       
    65 .. automodule:: pyams_utils.date
       
    66     :members:
       
    67     :undoc-members:
       
    68     :show-inheritance:
       
    69 
       
    70 pyams\_utils\.decorator module
       
    71 ------------------------------
       
    72 
       
    73 .. automodule:: pyams_utils.decorator
       
    74     :members:
       
    75     :undoc-members:
       
    76     :show-inheritance:
       
    77 
       
    78 pyams\_utils\.dict module
       
    79 -------------------------
       
    80 
       
    81 .. automodule:: pyams_utils.dict
       
    82     :members:
       
    83     :undoc-members:
       
    84     :show-inheritance:
       
    85 
       
    86 pyams\_utils\.encoding module
       
    87 -----------------------------
       
    88 
       
    89 .. automodule:: pyams_utils.encoding
       
    90     :members:
       
    91     :undoc-members:
       
    92     :show-inheritance:
       
    93 
       
    94 pyams\_utils\.fanstatic module
       
    95 ------------------------------
       
    96 
       
    97 .. automodule:: pyams_utils.fanstatic
       
    98     :members:
       
    99     :undoc-members:
       
   100     :show-inheritance:
       
   101 
       
   102 pyams\_utils\.html module
       
   103 -------------------------
       
   104 
       
   105 .. automodule:: pyams_utils.html
       
   106     :members:
       
   107     :undoc-members:
       
   108     :show-inheritance:
       
   109 
       
   110 pyams\_utils\.i18n module
       
   111 -------------------------
       
   112 
       
   113 .. automodule:: pyams_utils.i18n
       
   114     :members:
       
   115     :undoc-members:
       
   116     :show-inheritance:
       
   117 
       
   118 pyams\_utils\.include module
       
   119 ----------------------------
       
   120 
       
   121 .. automodule:: pyams_utils.include
       
   122     :members:
       
   123     :undoc-members:
       
   124     :show-inheritance:
       
   125 
       
   126 pyams\_utils\.inherit module
       
   127 ----------------------------
       
   128 
       
   129 .. automodule:: pyams_utils.inherit
       
   130     :members:
       
   131     :undoc-members:
       
   132     :show-inheritance:
       
   133 
       
   134 pyams\_utils\.intids module
       
   135 ---------------------------
       
   136 
       
   137 .. automodule:: pyams_utils.intids
       
   138     :members:
       
   139     :undoc-members:
       
   140     :show-inheritance:
       
   141 
       
   142 pyams\_utils\.list module
       
   143 -------------------------
       
   144 
       
   145 .. automodule:: pyams_utils.list
       
   146     :members:
       
   147     :undoc-members:
       
   148     :show-inheritance:
       
   149 
       
   150 pyams\_utils\.lock module
       
   151 -------------------------
       
   152 
       
   153 .. automodule:: pyams_utils.lock
       
   154     :members:
       
   155     :undoc-members:
       
   156     :show-inheritance:
       
   157 
       
   158 pyams\_utils\.progress module
       
   159 -----------------------------
       
   160 
       
   161 .. automodule:: pyams_utils.progress
       
   162     :members:
       
   163     :undoc-members:
       
   164     :show-inheritance:
       
   165 
       
   166 pyams\_utils\.property module
       
   167 -----------------------------
       
   168 
       
   169 .. automodule:: pyams_utils.property
       
   170     :members:
       
   171     :undoc-members:
       
   172     :show-inheritance:
       
   173 
       
   174 pyams\_utils\.registry module
       
   175 -----------------------------
       
   176 
       
   177 .. automodule:: pyams_utils.registry
       
   178     :members:
       
   179     :undoc-members:
       
   180     :show-inheritance:
       
   181 
       
   182 pyams\_utils\.request module
       
   183 ----------------------------
       
   184 
       
   185 .. automodule:: pyams_utils.request
       
   186     :members:
       
   187     :undoc-members:
       
   188     :show-inheritance:
       
   189 
       
   190 pyams\_utils\.schema module
       
   191 ---------------------------
       
   192 
       
   193 .. automodule:: pyams_utils.schema
       
   194     :members:
       
   195     :undoc-members:
       
   196     :show-inheritance:
       
   197 
       
   198 pyams\_utils\.session module
       
   199 ----------------------------
       
   200 
       
   201 .. automodule:: pyams_utils.session
       
   202     :members:
       
   203     :undoc-members:
       
   204     :show-inheritance:
       
   205 
       
   206 pyams\_utils\.site module
       
   207 -------------------------
       
   208 
       
   209 .. automodule:: pyams_utils.site
       
   210     :members:
       
   211     :undoc-members:
       
   212     :show-inheritance:
       
   213 
       
   214 pyams\_utils\.size module
       
   215 -------------------------
       
   216 
       
   217 .. automodule:: pyams_utils.size
       
   218     :members:
       
   219     :undoc-members:
       
   220     :show-inheritance:
       
   221 
       
   222 pyams\_utils\.tales module
       
   223 --------------------------
       
   224 
       
   225 .. automodule:: pyams_utils.tales
       
   226     :members:
       
   227     :undoc-members:
       
   228     :show-inheritance:
       
   229 
       
   230 pyams\_utils\.text module
       
   231 -------------------------
       
   232 
       
   233 .. automodule:: pyams_utils.text
       
   234     :members:
       
   235     :undoc-members:
       
   236     :show-inheritance:
       
   237 
       
   238 pyams\_utils\.traversing module
       
   239 -------------------------------
       
   240 
       
   241 .. automodule:: pyams_utils.traversing
       
   242     :members:
       
   243     :undoc-members:
       
   244     :show-inheritance:
       
   245 
       
   246 pyams\_utils\.unicode module
       
   247 ----------------------------
       
   248 
       
   249 .. automodule:: pyams_utils.unicode
       
   250     :members:
       
   251     :undoc-members:
       
   252     :show-inheritance:
       
   253 
       
   254 pyams\_utils\.url module
       
   255 ------------------------
       
   256 
       
   257 .. automodule:: pyams_utils.url
       
   258     :members:
       
   259     :undoc-members:
       
   260     :show-inheritance:
       
   261 
       
   262 pyams\_utils\.vocabulary module
       
   263 -------------------------------
       
   264 
       
   265 .. automodule:: pyams_utils.vocabulary
   262 .. automodule:: pyams_utils.vocabulary
   266     :members:
   263     :members:
   267     :undoc-members:
   264     :undoc-members:
   268     :show-inheritance:
   265     :show-inheritance:
   269 
   266 
   270 pyams\_utils\.wsgi module
   267 pyams_utils.\ ``wsgi``
   271 -------------------------
   268 ----------------------
   272 
   269 
   273 .. automodule:: pyams_utils.wsgi
   270 .. automodule:: pyams_utils.wsgi
   274     :members:
   271     :members:
   275     :undoc-members:
   272     :undoc-members:
   276     :show-inheritance:
   273     :show-inheritance:
   277 
   274 
   278 pyams\_utils\.zodb module
   275 pyams_utils.\ ``zodb``
   279 -------------------------
   276 ----------------------
   280 
   277 
   281 .. automodule:: pyams_utils.zodb
   278 .. automodule:: pyams_utils.zodb
   282     :members:
   279     :members:
   283     :undoc-members:
   280     :undoc-members:
   284     :show-inheritance:
   281     :show-inheritance:
   285 
   282 
   286 
   283 
   287 Subpackages
   284 Subpackages
   288 +++++++++++
   285 -----------
   289 
   286 
   290 .. toctree::
   287 .. toctree::
   291 
   288 
   292     pyams_utils.interfaces
   289     pyams_utils.interfaces
   293     pyams_utils.timezone
   290     pyams_utils.timezone