Skip to content

Commit 4fdd8d9

Browse files
committed
doc sets and BaseException
1 parent 1065712 commit 4fdd8d9

File tree

6 files changed

+428
-82
lines changed

6 files changed

+428
-82
lines changed

Misc/make_pydocs.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,16 @@ class C:
5353
complex,
5454
opt('bool'),
5555
classmethod,
56+
set,
57+
frozenset,
58+
BaseException,
5659
#buffer,
5760
# +
5861
type(f),
5962
type(m),
6063
type(f.func_code),
6164
type(sys._getframe()),
6265
type(tb),
63-
#type(slice),
6466
]
6567

6668
outfile = open("BuiltinDocs.java", "w")
@@ -75,5 +77,3 @@ class C:
7577
print_doc(outfile, obj, meth)
7678

7779
print >> outfile, '}'
78-
79-

src/org/python/core/BuiltinDocs.java

Lines changed: 349 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2658,6 +2658,355 @@ public class BuiltinDocs {
26582658
public final static String classmethod___str___doc =
26592659
"x.__str__() <==> str(x)";
26602660

2661+
// Docs for <type 'set'>
2662+
public final static String set___and___doc =
2663+
"x.__and__(y) <==> x&y";
2664+
2665+
public final static String set___class___doc =
2666+
"type(object) -> the object's type\n" +
2667+
"type(name, bases, dict) -> a new type";
2668+
2669+
public final static String set___cmp___doc =
2670+
"x.__cmp__(y) <==> cmp(x,y)";
2671+
2672+
public final static String set___contains___doc =
2673+
"x.__contains__(y) <==> y in x.";
2674+
2675+
public final static String set___delattr___doc =
2676+
"x.__delattr__('name') <==> del x.name";
2677+
2678+
public final static String set_doc =
2679+
"set(iterable) --> set object\n" +
2680+
"\n" +
2681+
"Build an unordered collection of unique elements.";
2682+
2683+
public final static String set___eq___doc =
2684+
"x.__eq__(y) <==> x==y";
2685+
2686+
public final static String set___ge___doc =
2687+
"x.__ge__(y) <==> x>=y";
2688+
2689+
public final static String set___getattribute___doc =
2690+
"x.__getattribute__('name') <==> x.name";
2691+
2692+
public final static String set___gt___doc =
2693+
"x.__gt__(y) <==> x>y";
2694+
2695+
public final static String set___hash___doc =
2696+
"x.__hash__() <==> hash(x)";
2697+
2698+
public final static String set___iand___doc =
2699+
"x.__iand__(y) <==> x&y";
2700+
2701+
public final static String set___init___doc =
2702+
"x.__init__(...) initializes x; see x.__class__.__doc__ for signature";
2703+
2704+
public final static String set___ior___doc =
2705+
"x.__ior__(y) <==> x|y";
2706+
2707+
public final static String set___isub___doc =
2708+
"x.__isub__(y) <==> x-y";
2709+
2710+
public final static String set___iter___doc =
2711+
"x.__iter__() <==> iter(x)";
2712+
2713+
public final static String set___ixor___doc =
2714+
"x.__ixor__(y) <==> x^y";
2715+
2716+
public final static String set___le___doc =
2717+
"x.__le__(y) <==> x<=y";
2718+
2719+
public final static String set___len___doc =
2720+
"x.__len__() <==> len(x)";
2721+
2722+
public final static String set___lt___doc =
2723+
"x.__lt__(y) <==> x<y";
2724+
2725+
public final static String set___ne___doc =
2726+
"x.__ne__(y) <==> x!=y";
2727+
2728+
public final static String set___new___doc =
2729+
"T.__new__(S, ...) -> a new object with type S, a subtype of T";
2730+
2731+
public final static String set___or___doc =
2732+
"x.__or__(y) <==> x|y";
2733+
2734+
public final static String set___rand___doc =
2735+
"x.__rand__(y) <==> y&x";
2736+
2737+
public final static String set___reduce___doc =
2738+
"Return state information for pickling.";
2739+
2740+
public final static String set___reduce_ex___doc =
2741+
"helper for pickle";
2742+
2743+
public final static String set___repr___doc =
2744+
"x.__repr__() <==> repr(x)";
2745+
2746+
public final static String set___ror___doc =
2747+
"x.__ror__(y) <==> y|x";
2748+
2749+
public final static String set___rsub___doc =
2750+
"x.__rsub__(y) <==> y-x";
2751+
2752+
public final static String set___rxor___doc =
2753+
"x.__rxor__(y) <==> y^x";
2754+
2755+
public final static String set___setattr___doc =
2756+
"x.__setattr__('name', value) <==> x.name = value";
2757+
2758+
public final static String set___str___doc =
2759+
"x.__str__() <==> str(x)";
2760+
2761+
public final static String set___sub___doc =
2762+
"x.__sub__(y) <==> x-y";
2763+
2764+
public final static String set___xor___doc =
2765+
"x.__xor__(y) <==> x^y";
2766+
2767+
public final static String set_add_doc =
2768+
"Add an element to a set.\n" +
2769+
"\n" +
2770+
"This has no effect if the element is already present.";
2771+
2772+
public final static String set_clear_doc =
2773+
"Remove all elements from this set.";
2774+
2775+
public final static String set_copy_doc =
2776+
"Return a shallow copy of a set.";
2777+
2778+
public final static String set_difference_doc =
2779+
"Return the difference of two sets as a new set.\n" +
2780+
"\n" +
2781+
"(i.e. all elements that are in this set but not the other.)";
2782+
2783+
public final static String set_difference_update_doc =
2784+
"Remove all elements of another set from this set.";
2785+
2786+
public final static String set_discard_doc =
2787+
"Remove an element from a set if it is a member.\n" +
2788+
"\n" +
2789+
"If the element is not a member, do nothing.";
2790+
2791+
public final static String set_intersection_doc =
2792+
"Return the intersection of two sets as a new set.\n" +
2793+
"\n" +
2794+
"(i.e. all elements that are in both sets.)";
2795+
2796+
public final static String set_intersection_update_doc =
2797+
"Update a set with the intersection of itself and another.";
2798+
2799+
public final static String set_issubset_doc =
2800+
"Report whether another set contains this set.";
2801+
2802+
public final static String set_issuperset_doc =
2803+
"Report whether this set contains another set.";
2804+
2805+
public final static String set_pop_doc =
2806+
"Remove and return an arbitrary set element.";
2807+
2808+
public final static String set_remove_doc =
2809+
"Remove an element from a set; it must be a member.\n" +
2810+
"\n" +
2811+
"If the element is not a member, raise a KeyError.";
2812+
2813+
public final static String set_symmetric_difference_doc =
2814+
"Return the symmetric difference of two sets as a new set.\n" +
2815+
"\n" +
2816+
"(i.e. all elements that are in exactly one of the sets.)";
2817+
2818+
public final static String set_symmetric_difference_update_doc =
2819+
"Update a set with the symmetric difference of itself and another.";
2820+
2821+
public final static String set_union_doc =
2822+
"Return the union of two sets as a new set.\n" +
2823+
"\n" +
2824+
"(i.e. all elements that are in either set.)";
2825+
2826+
public final static String set_update_doc =
2827+
"Update a set with the union of itself and another.";
2828+
2829+
// Docs for <type 'frozenset'>
2830+
public final static String frozenset___and___doc =
2831+
"x.__and__(y) <==> x&y";
2832+
2833+
public final static String frozenset___class___doc =
2834+
"type(object) -> the object's type\n" +
2835+
"type(name, bases, dict) -> a new type";
2836+
2837+
public final static String frozenset___cmp___doc =
2838+
"x.__cmp__(y) <==> cmp(x,y)";
2839+
2840+
public final static String frozenset___contains___doc =
2841+
"x.__contains__(y) <==> y in x.";
2842+
2843+
public final static String frozenset___delattr___doc =
2844+
"x.__delattr__('name') <==> del x.name";
2845+
2846+
public final static String frozenset_doc =
2847+
"frozenset(iterable) --> frozenset object\n" +
2848+
"\n" +
2849+
"Build an immutable unordered collection of unique elements.";
2850+
2851+
public final static String frozenset___eq___doc =
2852+
"x.__eq__(y) <==> x==y";
2853+
2854+
public final static String frozenset___ge___doc =
2855+
"x.__ge__(y) <==> x>=y";
2856+
2857+
public final static String frozenset___getattribute___doc =
2858+
"x.__getattribute__('name') <==> x.name";
2859+
2860+
public final static String frozenset___gt___doc =
2861+
"x.__gt__(y) <==> x>y";
2862+
2863+
public final static String frozenset___hash___doc =
2864+
"x.__hash__() <==> hash(x)";
2865+
2866+
public final static String frozenset___init___doc =
2867+
"x.__init__(...) initializes x; see x.__class__.__doc__ for signature";
2868+
2869+
public final static String frozenset___iter___doc =
2870+
"x.__iter__() <==> iter(x)";
2871+
2872+
public final static String frozenset___le___doc =
2873+
"x.__le__(y) <==> x<=y";
2874+
2875+
public final static String frozenset___len___doc =
2876+
"x.__len__() <==> len(x)";
2877+
2878+
public final static String frozenset___lt___doc =
2879+
"x.__lt__(y) <==> x<y";
2880+
2881+
public final static String frozenset___ne___doc =
2882+
"x.__ne__(y) <==> x!=y";
2883+
2884+
public final static String frozenset___new___doc =
2885+
"T.__new__(S, ...) -> a new object with type S, a subtype of T";
2886+
2887+
public final static String frozenset___or___doc =
2888+
"x.__or__(y) <==> x|y";
2889+
2890+
public final static String frozenset___rand___doc =
2891+
"x.__rand__(y) <==> y&x";
2892+
2893+
public final static String frozenset___reduce___doc =
2894+
"Return state information for pickling.";
2895+
2896+
public final static String frozenset___reduce_ex___doc =
2897+
"helper for pickle";
2898+
2899+
public final static String frozenset___repr___doc =
2900+
"x.__repr__() <==> repr(x)";
2901+
2902+
public final static String frozenset___ror___doc =
2903+
"x.__ror__(y) <==> y|x";
2904+
2905+
public final static String frozenset___rsub___doc =
2906+
"x.__rsub__(y) <==> y-x";
2907+
2908+
public final static String frozenset___rxor___doc =
2909+
"x.__rxor__(y) <==> y^x";
2910+
2911+
public final static String frozenset___setattr___doc =
2912+
"x.__setattr__('name', value) <==> x.name = value";
2913+
2914+
public final static String frozenset___str___doc =
2915+
"x.__str__() <==> str(x)";
2916+
2917+
public final static String frozenset___sub___doc =
2918+
"x.__sub__(y) <==> x-y";
2919+
2920+
public final static String frozenset___xor___doc =
2921+
"x.__xor__(y) <==> x^y";
2922+
2923+
public final static String frozenset_copy_doc =
2924+
"Return a shallow copy of a set.";
2925+
2926+
public final static String frozenset_difference_doc =
2927+
"Return the difference of two sets as a new set.\n" +
2928+
"\n" +
2929+
"(i.e. all elements that are in this set but not the other.)";
2930+
2931+
public final static String frozenset_intersection_doc =
2932+
"Return the intersection of two sets as a new set.\n" +
2933+
"\n" +
2934+
"(i.e. all elements that are in both sets.)";
2935+
2936+
public final static String frozenset_issubset_doc =
2937+
"Report whether another set contains this set.";
2938+
2939+
public final static String frozenset_issuperset_doc =
2940+
"Report whether this set contains another set.";
2941+
2942+
public final static String frozenset_symmetric_difference_doc =
2943+
"Return the symmetric difference of two sets as a new set.\n" +
2944+
"\n" +
2945+
"(i.e. all elements that are in exactly one of the sets.)";
2946+
2947+
public final static String frozenset_union_doc =
2948+
"Return the union of two sets as a new set.\n" +
2949+
"\n" +
2950+
"(i.e. all elements that are in either set.)";
2951+
2952+
// Docs for <type 'exceptions.BaseException'>
2953+
public final static String BaseException___class___doc =
2954+
"type(object) -> the object's type\n" +
2955+
"type(name, bases, dict) -> a new type";
2956+
2957+
public final static String BaseException___delattr___doc =
2958+
"x.__delattr__('name') <==> del x.name";
2959+
2960+
public final static String BaseException___dict___doc =
2961+
"";
2962+
2963+
public final static String BaseException_doc =
2964+
"Common base class for all exceptions";
2965+
2966+
public final static String BaseException___getattribute___doc =
2967+
"x.__getattribute__('name') <==> x.name";
2968+
2969+
public final static String BaseException___getitem___doc =
2970+
"x.__getitem__(y) <==> x[y]";
2971+
2972+
public final static String BaseException___getslice___doc =
2973+
"x.__getslice__(i, j) <==> x[i:j]\n" +
2974+
" \n" +
2975+
" Use of negative indices is not supported.";
2976+
2977+
public final static String BaseException___hash___doc =
2978+
"x.__hash__() <==> hash(x)";
2979+
2980+
public final static String BaseException___init___doc =
2981+
"x.__init__(...) initializes x; see x.__class__.__doc__ for signature";
2982+
2983+
public final static String BaseException___new___doc =
2984+
"T.__new__(S, ...) -> a new object with type S, a subtype of T";
2985+
2986+
public final static String BaseException___reduce___doc =
2987+
"";
2988+
2989+
public final static String BaseException___reduce_ex___doc =
2990+
"helper for pickle";
2991+
2992+
public final static String BaseException___repr___doc =
2993+
"x.__repr__() <==> repr(x)";
2994+
2995+
public final static String BaseException___setattr___doc =
2996+
"x.__setattr__('name', value) <==> x.name = value";
2997+
2998+
public final static String BaseException___setstate___doc =
2999+
"";
3000+
3001+
public final static String BaseException___str___doc =
3002+
"x.__str__() <==> str(x)";
3003+
3004+
public final static String BaseException_args_doc =
3005+
"";
3006+
3007+
public final static String BaseException_message_doc =
3008+
"exception message";
3009+
26613010
// Docs for <type 'function'>
26623011
public final static String function___call___doc =
26633012
"x.__call__(...) <==> x(...)";

0 commit comments

Comments
 (0)