|
14 | 14 | "col_offset": 1, |
15 | 15 | "end_col_offset": 3, |
16 | 16 | "end_lineno": 21, |
17 | | - "lineno": 21, |
| 17 | + "lineno": 9, |
18 | 18 | "noops_previous": { |
19 | 19 | "ast_type": "PreviousNoops", |
20 | 20 | "col_offset": 1, |
|
444 | 444 | "col_offset": 1, |
445 | 445 | "end_col_offset": 30, |
446 | 446 | "end_lineno": 56, |
447 | | - "lineno": 56, |
| 447 | + "lineno": 49, |
448 | 448 | "s": "A cache containing the API documentation for values that we've\nalready seen. This cache is implemented as a dictionary that maps a\nvalue's pyid to its L{ValueDoc}.\n\nNote that if we encounter a value but decide not to introspect it\n(because it's imported from another module), then C{_valuedoc_cache}\nwill contain an entry for the value, but the value will not be listed\nin L{_introspected_values}." |
449 | 449 | } |
450 | 450 | }, |
|
495 | 495 | "col_offset": 1, |
496 | 496 | "end_col_offset": 19, |
497 | 497 | "end_lineno": 60, |
498 | | - "lineno": 60, |
| 498 | + "lineno": 59, |
499 | 499 | "s": "A record which values we've introspected, encoded as a dictionary from\npyid to C{bool}." |
500 | 500 | } |
501 | 501 | }, |
|
518 | 518 | "col_offset": 5, |
519 | 519 | "end_col_offset": 7, |
520 | 520 | "end_lineno": 66, |
521 | | - "lineno": 66, |
| 521 | + "lineno": 63, |
522 | 522 | "noops_previous": { |
523 | 523 | "ast_type": "PreviousNoops", |
524 | 524 | "col_offset": 1, |
|
777 | 777 | "col_offset": 5, |
778 | 778 | "end_col_offset": 7, |
779 | 779 | "end_lineno": 99, |
780 | | - "lineno": 99, |
| 780 | + "lineno": 76, |
781 | 781 | "s": "\n Generate the API documentation for a specified object by\n introspecting Python values, and return it as a L{ValueDoc}. The\n object to generate documentation for may be specified using\n the C{value} parameter, the C{filename} parameter, I{or} the\n C{name} parameter. (It is an error to specify more than one\n of these three parameters, or to not specify any of them.)\n\n @param value: The python object that should be documented.\n @param filename: The name of the file that contains the python\n source code for a package, module, or script. If\n C{filename} is specified, then C{introspect} will return a\n C{ModuleDoc} describing its contents.\n @param name: The fully-qualified python dotted name of any\n value (including packages, modules, classes, and\n functions). C{DocParser} will automatically figure out\n which module(s) it needs to import in order to find the\n documentation for the specified object.\n @param context: The API documentation for the class of module\n that contains C{value} (if available).\n @param module_name: The name of the module where the value is defined.\n Useful to retrieve the docstring encoding if there is no way to\n detect the module by introspection (such as in properties)\n " |
782 | 782 | } |
783 | 783 | }, |
|
2606 | 2606 | "col_offset": 5, |
2607 | 2607 | "end_col_offset": 7, |
2608 | 2608 | "end_lineno": 156, |
2609 | | - "lineno": 156, |
| 2609 | + "lineno": 150, |
2610 | 2610 | "s": "\n If a C{ValueDoc} for the given value exists in the valuedoc\n cache, then return it; otherwise, create a new C{ValueDoc},\n add it to the cache, and return it. When possible, the new\n C{ValueDoc}'s C{pyval}, C{repr}, and C{canonical_name}\n attributes will be set appropriately.\n " |
2611 | 2611 | } |
2612 | 2612 | }, |
|
3686 | 3686 | "col_offset": 5, |
3687 | 3687 | "end_col_offset": 7, |
3688 | 3688 | "end_lineno": 194, |
3689 | | - "lineno": 194, |
| 3689 | + "lineno": 191, |
3690 | 3690 | "s": "\n Add API documentation information about the module C{module}\n to C{module_doc}.\n " |
3691 | 3691 | } |
3692 | 3692 | }, |
|
7375 | 7375 | "col_offset": 5, |
7376 | 7376 | "end_col_offset": 7, |
7377 | 7377 | "end_lineno": 330, |
7378 | | - "lineno": 330, |
| 7378 | + "lineno": 327, |
7379 | 7379 | "s": "\n Add API documentation information about the class C{cls}\n to C{class_doc}.\n " |
7380 | 7380 | } |
7381 | 7381 | }, |
|
9739 | 9739 | "col_offset": 5, |
9740 | 9740 | "end_col_offset": 72, |
9741 | 9741 | "end_lineno": 416, |
9742 | | - "lineno": 416, |
| 9742 | + "lineno": 415, |
9743 | 9743 | "s": "Add API documentation information about the function\n C{routine} to C{routine_doc} (specializing it to C{Routine_doc})." |
9744 | 9744 | } |
9745 | 9745 | }, |
|
11772 | 11772 | "col_offset": 5, |
11773 | 11773 | "end_col_offset": 66, |
11774 | 11774 | "end_lineno": 482, |
11775 | | - "lineno": 482, |
| 11775 | + "lineno": 481, |
11776 | 11776 | "s": "Add API documentation information about the property\n C{prop} to C{prop_doc} (specializing it to C{PropertyDoc})." |
11777 | 11777 | } |
11778 | 11778 | }, |
|
12432 | 12432 | "col_offset": 5, |
12433 | 12433 | "end_col_offset": 7, |
12434 | 12434 | "end_lineno": 518, |
12435 | | - "lineno": 518, |
| 12435 | + "lineno": 510, |
12436 | 12436 | "s": "\n Return true if the given object is a class. In particular, return\n true if object is an instance of C{types.TypeType} or of\n C{types.ClassType}. This is used instead of C{inspect.isclass()},\n because the latter returns true for objects that are not classes\n (in particular, it returns true for any object that has a\n C{__bases__} attribute, including objects that define\n C{__getattr__} to always return a value).\n " |
12437 | 12437 | } |
12438 | 12438 | }, |
|
12640 | 12640 | "col_offset": 5, |
12641 | 12641 | "end_col_offset": 20, |
12642 | 12642 | "end_lineno": 527, |
12643 | | - "lineno": 527, |
| 12643 | + "lineno": 525, |
12644 | 12644 | "s": "Add a type to the lists of types that should be treated as\n classes. By default, this list contains C{TypeType} and\n C{ClassType}." |
12645 | 12645 | } |
12646 | 12646 | }, |
|
12778 | 12778 | "col_offset": 5, |
12779 | 12779 | "end_col_offset": 7, |
12780 | 12780 | "end_lineno": 536, |
12781 | | - "lineno": 536, |
| 12781 | + "lineno": 533, |
12782 | 12782 | "s": "\n Return True if C{object} results from a C{from __future__ import feature}\n statement.\n " |
12783 | 12783 | } |
12784 | 12784 | }, |
|
13186 | 13186 | "col_offset": 5, |
13187 | 13187 | "end_col_offset": 7, |
13188 | 13188 | "end_lineno": 560, |
13189 | | - "lineno": 560, |
| 13189 | + "lineno": 556, |
13190 | 13190 | "s": "\n Return the docstring for the given value; or C{None} if it\n does not have a docstring.\n @rtype: C{unicode}\n " |
13191 | 13191 | } |
13192 | 13192 | }, |
|
14454 | 14454 | "col_offset": 5, |
14455 | 14455 | "end_col_offset": 7, |
14456 | 14456 | "end_lineno": 605, |
14457 | | - "lineno": 605, |
| 14457 | + "lineno": 597, |
14458 | 14458 | "s": "\n @return: the canonical name for C{value}, or C{UNKNOWN} if no\n canonical name can be found. Currently, C{get_canonical_name}\n can find canonical names for: modules; functions; non-nested\n classes; methods of non-nested classes; and some class methods\n of non-nested classes.\n \n @rtype: L{DottedName} or C{UNKNOWN}\n " |
14459 | 14459 | } |
14460 | 14460 | }, |
|
16463 | 16463 | "col_offset": 5, |
16464 | 16464 | "end_col_offset": 7, |
16465 | 16465 | "end_lineno": 658, |
16466 | | - "lineno": 658, |
| 16466 | + "lineno": 655, |
16467 | 16467 | "s": "\n Verify the name. E.g., if it's a nested class, then we won't be\n able to find it with the name we constructed.\n " |
16468 | 16468 | } |
16469 | 16469 | }, |
|
17288 | 17288 | "col_offset": 5, |
17289 | 17289 | "end_col_offset": 7, |
17290 | 17290 | "end_lineno": 687, |
17291 | | - "lineno": 687, |
| 17291 | + "lineno": 683, |
17292 | 17292 | "s": "\n Return the name of the module containing the given value, or\n C{None} if the module name can't be determined.\n @rtype: L{DottedName}\n " |
17293 | 17293 | } |
17294 | 17294 | }, |
|
18008 | 18008 | "col_offset": 5, |
18009 | 18009 | "end_col_offset": 7, |
18010 | 18010 | "end_lineno": 710, |
18011 | | - "lineno": 710, |
| 18011 | + "lineno": 705, |
18012 | 18012 | "s": "\n @return: The module that defines the given function.\n @rtype: C{module}\n @param func: The function whose module should be found.\n @type func: C{function}\n " |
18013 | 18013 | } |
18014 | 18014 | }, |
|
18634 | 18634 | "col_offset": 5, |
18635 | 18635 | "end_col_offset": 7, |
18636 | 18636 | "end_lineno": 752, |
18637 | | - "lineno": 752, |
| 18637 | + "lineno": 736, |
18638 | 18638 | "s": "\n Register an introspecter function. Introspecter functions take\n two arguments, a python value and a C{ValueDoc} object, and should\n add information about the given value to the the C{ValueDoc}.\n Usually, the first line of an inspecter function will specialize\n it to a sublass of C{ValueDoc}, using L{ValueDoc.specialize_to()}:\n\n >>> def typical_introspecter(value, value_doc):\n ... value_doc.specialize_to(SomeSubclassOfValueDoc)\n ... <add info to value_doc>\n\n @param priority: The priority of this introspecter, which determines\n the order in which introspecters are tried -- introspecters with lower\n numbers are tried first. The standard introspecters have priorities\n ranging from 20 to 30. The default priority (10) will place new\n introspecters before standard introspecters.\n " |
18639 | 18639 | } |
18640 | 18640 | }, |
|
21835 | 21835 | "col_offset": 5, |
21836 | 21836 | "end_col_offset": 7, |
21837 | 21837 | "end_lineno": 859, |
21838 | | - "lineno": 859, |
| 21838 | + "lineno": 854, |
21839 | 21839 | "s": "\n Given a name, return the corresponding value.\n \n @param globs: A namespace to check for the value, if there is no\n module containing the named value. Defaults to __builtin__.\n " |
21840 | 21840 | } |
21841 | 21841 | }, |
|
23161 | 23161 | "col_offset": 5, |
23162 | 23162 | "end_col_offset": 7, |
23163 | 23163 | "end_lineno": 897, |
23164 | | - "lineno": 897, |
| 23164 | + "lineno": 893, |
23165 | 23165 | "s": "\n Run the given callable in a 'sandboxed' environment.\n Currently, this includes saving and restoring the contents of\n sys and __builtins__; and suppressing stdin, stdout, and stderr.\n " |
23166 | 23166 | } |
23167 | 23167 | }, |
|
24541 | 24541 | "col_offset": 5, |
24542 | 24542 | "end_col_offset": 7, |
24543 | 24543 | "end_lineno": 950, |
24544 | | - "lineno": 950, |
| 24544 | + "lineno": 945, |
24545 | 24545 | "s": "\n Try to determine the line number on which the given item's\n docstring begins. Return the line number, or C{None} if the line\n number can't be determined. The line number of the first line in\n the file is 1.\n " |
24546 | 24546 | } |
24547 | 24547 | }, |
|
25319 | 25319 | "col_offset": 5, |
25320 | 25320 | "end_col_offset": 7, |
25321 | 25321 | "end_lineno": 974, |
25322 | | - "lineno": 974, |
| 25322 | + "lineno": 969, |
25323 | 25323 | "noops_previous": { |
25324 | 25324 | "ast_type": "PreviousNoops", |
25325 | 25325 | "col_offset": 1, |
|
26673 | 26673 | "col_offset": 1, |
26674 | 26674 | "end_col_offset": 3, |
26675 | 26675 | "end_lineno": 1056, |
26676 | | - "lineno": 1056, |
| 26676 | + "lineno": 1029, |
26677 | 26677 | "s": "\n######################################################################\n## Zope Extension...\n######################################################################\nclass ZopeIntrospecter(Introspecter):\n VALUEDOC_CLASSES = Introspecter.VALUEDOC_CLASSES.copy()\n VALUEDOC_CLASSES.update({\n 'module': ZopeModuleDoc,\n 'class': ZopeClassDoc,\n 'interface': ZopeInterfaceDoc,\n 'attribute': ZopeAttributeDoc,\n })\n \n def add_module_child(self, child, child_name, module_doc):\n if isinstance(child, zope.interfaces.Interface):\n module_doc.add_zope_interface(child_name)\n else:\n Introspecter.add_module_child(self, child, child_name, module_doc)\n\n def add_class_child(self, child, child_name, class_doc):\n if isinstance(child, zope.interfaces.Interface):\n class_doc.add_zope_interface(child_name)\n else:\n Introspecter.add_class_child(self, child, child_name, class_doc)\n\n def introspect_zope_interface(self, interface, interfacename):\n pass # etc...\n" |
26678 | 26678 | } |
26679 | 26679 | } |
|
0 commit comments