objxp 1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
objxp/__init__.py ADDED
@@ -0,0 +1,260 @@
1
+ import os
2
+ import json
3
+ import shutil
4
+ from typing import Literal, Optional, Union
5
+
6
+
7
+ def get_terminal_size_shutil():
8
+ return shutil.get_terminal_size((80, 20)) # Default width and height
9
+
10
+ terminal_size = get_terminal_size_shutil()
11
+
12
+ initial_classes = {
13
+
14
+ 'func' : [
15
+ "function",
16
+ "module",
17
+ ],
18
+
19
+ 'data' : [
20
+ "int",
21
+ "float",
22
+ "bool",
23
+ "str",
24
+ "list",
25
+ "dict",
26
+ "set",
27
+ "tuple",
28
+ ],
29
+
30
+ 'builtin' : [
31
+ "builtin_function_or_method",
32
+ ],
33
+
34
+ 'other' : [
35
+ "type",
36
+ "method-wrapper",
37
+ "nonetype"
38
+ ]
39
+ }
40
+
41
+
42
+ resjson = {
43
+ "objname":"",
44
+ "objitms":[]
45
+ }
46
+
47
+
48
+ def safe_type(obj, attr):
49
+ try:
50
+ return str(type(getattr(obj, attr)))
51
+ except Exception:
52
+ return "unavailable"
53
+
54
+ def title_case(content: str, level: int = 1, outputType: str = "screen") -> str:
55
+ """
56
+ Convert the first letter of each word in the string to uppercase.
57
+ """
58
+ if level == 1:
59
+ if outputType == "screen":
60
+ return "\n\033[1;44m "+content+" \033[0m\n\n"
61
+ else:
62
+ # For markdown output
63
+ return "\n## "+content+"\n\n"
64
+ elif level == 2:
65
+ # For level 2, we assume the content is a type name
66
+ typename = content[8:-2].upper() # Remove the "class " prefix and ">" suffix
67
+ if outputType == "screen":
68
+ return "\n"*2+" "*2+"\033[1;40;34m "+typename+" \033[0m\033[40;34mmembers: \033[0m\n"
69
+ else:
70
+ # For markdown output
71
+ return "\n "+typename+" mmembers:\n"
72
+ def ox(
73
+ theobj: object="test",
74
+ ifprint = True,
75
+ savefile: str | None = 'both',
76
+ show_inner_members: str = 'none', # none show both, True show only inner members, False show only outer members
77
+ show_onlyknown: bool = False,
78
+ bygroup: bool = True
79
+ ):
80
+ """
81
+ function ox list members of theobj
82
+
83
+ param theobj: what to explor
84
+ param savefile: "md", "json", "both", None, if save the results to a file (md or json, or both of 2).
85
+ param show_inner_members: '_'(内部方法,_开头), '__'(私有方法,__开头), 'both'(_,__), 'dunder'(首尾都是__, 特殊方法), 'none'(only outer members), other string, show all.
86
+ param show_onlyknown: True ( 不包括非典型的自定义成员 ), False ( 包括非典成员 ), if only show known members of the object.
87
+ param ifprint: True, False, if print the results on console.
88
+
89
+ return: str results.
90
+
91
+ """
92
+
93
+ winww = terminal_size.columns-2
94
+ # print(f'Width: {terminal_size.columns}, Height: {terminal_size.lines}')
95
+ strBreakLine = "_"*winww+"\n"
96
+
97
+ resjson["objname"]=str(theobj)
98
+
99
+ result_content_text_screen = "\n"
100
+ result_content_text_screen += strBreakLine
101
+ result_content_text_screen += title_case("OBJ'S TYPE: ",1,"screen")
102
+ result_content_text_screen += " "*4+str(type(theobj))+"\n"
103
+ result_content_text_screen += strBreakLine
104
+ result_content_text_screen += title_case("OBJ'S MEMBERS: ",1,"screen")
105
+ print(result_content_text_screen) if ifprint else None
106
+
107
+ result_content_text_md = ""
108
+ result_content_text_md += strBreakLine
109
+ result_content_text_md += title_case("OBJ'S TYPE: ",1,"md")
110
+ result_content_text_md += " "*4+str(type(theobj))+"\n"
111
+ result_content_text_md += strBreakLine
112
+ result_content_text_md += title_case("OBJ'S MEMBERS: ",1,"md")
113
+
114
+ lstSortedMembers = sorted(
115
+ dir(theobj),
116
+ key=lambda x: safe_type(theobj,x)
117
+ )
118
+
119
+ previous_type_str = ""
120
+
121
+ typesWithEachTypesMembers = []
122
+ # typesWithEachTypesMembers:
123
+ # list of two elements: [typeName:str, members_of_this_type:list]
124
+
125
+ atypeitm = []
126
+
127
+ for objMember in lstSortedMembers:
128
+ current_type_str = safe_type(theobj,objMember)
129
+
130
+ if (previous_type_str != current_type_str):
131
+
132
+ typesWithEachTypesMembers.append([current_type_str,[]])
133
+
134
+ attrtype_all = initial_classes.get(current_type_str, ["other"])
135
+
136
+ previous_type_str = current_type_str
137
+
138
+ typesWithEachTypesMembers[-1][1].append(objMember)
139
+
140
+ resjson["objitms"]=typesWithEachTypesMembers
141
+
142
+ for aTypeWithThisTypesMembers in typesWithEachTypesMembers:
143
+
144
+ typeName = aTypeWithThisTypesMembers[0]
145
+
146
+ members = ""
147
+ classified_members = {}
148
+ for aMember in aTypeWithThisTypesMembers[1]:
149
+
150
+ # 处理内部成员过滤
151
+ is_dunder = aMember.startswith('__') and aMember.endswith('__') # 特殊方法
152
+ is_private = aMember.startswith('_') and not aMember.startswith('__') # 单下划线
153
+ is_very_private = aMember.startswith('__') and not aMember.endswith('__') # 双下划线
154
+
155
+ # 根据show_inner_members参数过滤
156
+ if show_inner_members == 'none':
157
+ # 不显示任何内部成员
158
+ if aMember.startswith('_'):
159
+ continue
160
+ elif show_inner_members == '_':
161
+ # 只显示单下划线受保护的成员,不显示双下划线私有和首尾双下划线特殊方法
162
+ if not is_private or is_dunder or is_very_private:
163
+ continue
164
+ elif show_inner_members == '__':
165
+ # 只显示双下划线成员,不显示单下划线和特殊方法
166
+ if not is_very_private or is_dunder:
167
+ continue
168
+ elif show_inner_members == 'dunder':
169
+ # 只特殊方法
170
+ if not is_dunder:
171
+ continue
172
+ # 'both' 显示所有成员,不需要过滤
173
+
174
+ # 处理名称修饰(name mangling)
175
+ display_name = aMember
176
+ if is_very_private and not isinstance(theobj, type):
177
+ # 对于实例对象,需要处理名称修饰
178
+ cls_name = theobj.__class__.__name__
179
+ display_name = f"_{cls_name}{aMember}"
180
+
181
+ # # 分类成员
182
+ # category, subcategory, value = classify_member(theobj, aMember)
183
+
184
+ # # 如果只显示已知类型且当前类型为'other',则跳过
185
+ # if show_onlyknown and category == 'other':
186
+ # continue
187
+
188
+ # # 将成员添加到分类中
189
+ # if category not in classified_members:
190
+ # classified_members[category] = []
191
+ # classified_members[category].append({
192
+ # 'name': display_name,
193
+ # 'type': subcategory,
194
+ # 'value': value
195
+ # })
196
+
197
+ members += display_name + ", "
198
+
199
+ if members.endswith(", "):
200
+
201
+ result_content_text_md += title_case(typeName,2,"md")
202
+ result_content_text_screen += title_case(typeName,2,"screen")
203
+
204
+ members = members[:-2]
205
+ result_content_text_md += members
206
+ result_content_text_screen += members
207
+
208
+ print(result_content_text_screen)
209
+
210
+ if savefile == "md" or savefile == "both":
211
+ with open("objxp"+".md",'w', encoding="UTF-8") as ff:
212
+ ff.write(result_content_text_md)
213
+
214
+ if savefile == "json" or savefile == "both":
215
+ with open("objxp"+".json",'w', encoding="UTF-8") as ff:
216
+ ff.write(json.dumps(resjson))
217
+
218
+ return result_content_text_md
219
+
220
+
221
+ # vars() is alternative to dirs(), or locals()
222
+
223
+
224
+ def what_is_vars():
225
+ locals = vars().copy()
226
+ for kk,vv in locals.items():
227
+ print(kk,type())
228
+
229
+ helpinfo = """
230
+ vars() 是 Python 内置的一个函数,用于返回对象的 dict 属性,这是一个包含对象属性和它们值的字典。对于大多数 Python 对象,vars() 返回的是对象的命名空间。如果对象没有 dict 属性,比如内置类型或没有定义 dict 的自定义对象,vars() 将引发 TypeError。
231
+
232
+ 例如:
233
+ ```python
234
+ class MyClass:
235
+ def __init__(self):
236
+ self.a = 1
237
+ self.b = 2
238
+
239
+ obj = MyClass()
240
+ print(vars(obj)) # 输出: {'a': 1, 'b': 2}
241
+ ```
242
+ 在没有参数的情况下调用 vars(),它等价于 locals(),返回当前作用域中的局部符号表,也是一个字典。
243
+
244
+ 例如:
245
+ ```python
246
+ def my_function():
247
+ x = 10
248
+ y = 20
249
+ print(vars()) # 输出: {'x': 10, 'y': 20}
250
+
251
+ my_function()
252
+
253
+ ```
254
+ 总结一下,vars() 主要用于获取对象的属性字典或当前作用域的局部符号表。
255
+
256
+
257
+ """
258
+
259
+ if __name__=="__main__":
260
+ ox(100)
objxp/__main__.py ADDED
File without changes
@@ -0,0 +1,465 @@
1
+ Metadata-Version: 2.4
2
+ Name: objxp
3
+ Version: 1
4
+ Summary: List the members in a Object[also Class or Module].
5
+ Author-email: lukelin <hongfoo@foxmail.com>
6
+ License: Mozilla Public License Version 2.0
7
+ ==================================
8
+
9
+ 1. Definitions
10
+ --------------
11
+
12
+ 1.1. "Contributor"
13
+ means each individual or legal entity that creates, contributes to
14
+ the creation of, or owns Covered Software.
15
+
16
+ 1.2. "Contributor Version"
17
+ means the combination of the Contributions of others (if any) used
18
+ by a Contributor and that particular Contributor's Contribution.
19
+
20
+ 1.3. "Contribution"
21
+ means Covered Software of a particular Contributor.
22
+
23
+ 1.4. "Covered Software"
24
+ means Source Code Form to which the initial Contributor has attached
25
+ the notice in Exhibit A, the Executable Form of such Source Code
26
+ Form, and Modifications of such Source Code Form, in each case
27
+ including portions thereof.
28
+
29
+ 1.5. "Incompatible With Secondary Licenses"
30
+ means
31
+
32
+ (a) that the initial Contributor has attached the notice described
33
+ in Exhibit B to the Covered Software; or
34
+
35
+ (b) that the Covered Software was made available under the terms of
36
+ version 1.1 or earlier of the License, but not also under the
37
+ terms of a Secondary License.
38
+
39
+ 1.6. "Executable Form"
40
+ means any form of the work other than Source Code Form.
41
+
42
+ 1.7. "Larger Work"
43
+ means a work that combines Covered Software with other material, in
44
+ a separate file or files, that is not Covered Software.
45
+
46
+ 1.8. "License"
47
+ means this document.
48
+
49
+ 1.9. "Licensable"
50
+ means having the right to grant, to the maximum extent possible,
51
+ whether at the time of the initial grant or subsequently, any and
52
+ all of the rights conveyed by this License.
53
+
54
+ 1.10. "Modifications"
55
+ means any of the following:
56
+
57
+ (a) any file in Source Code Form that results from an addition to,
58
+ deletion from, or modification of the contents of Covered
59
+ Software; or
60
+
61
+ (b) any new file in Source Code Form that contains any Covered
62
+ Software.
63
+
64
+ 1.11. "Patent Claims" of a Contributor
65
+ means any patent claim(s), including without limitation, method,
66
+ process, and apparatus claims, in any patent Licensable by such
67
+ Contributor that would be infringed, but for the grant of the
68
+ License, by the making, using, selling, offering for sale, having
69
+ made, import, or transfer of either its Contributions or its
70
+ Contributor Version.
71
+
72
+ 1.12. "Secondary License"
73
+ means either the GNU General Public License, Version 2.0, the GNU
74
+ Lesser General Public License, Version 2.1, the GNU Affero General
75
+ Public License, Version 3.0, or any later versions of those
76
+ licenses.
77
+
78
+ 1.13. "Source Code Form"
79
+ means the form of the work preferred for making modifications.
80
+
81
+ 1.14. "You" (or "Your")
82
+ means an individual or a legal entity exercising rights under this
83
+ License. For legal entities, "You" includes any entity that
84
+ controls, is controlled by, or is under common control with You. For
85
+ purposes of this definition, "control" means (a) the power, direct
86
+ or indirect, to cause the direction or management of such entity,
87
+ whether by contract or otherwise, or (b) ownership of more than
88
+ fifty percent (50%) of the outstanding shares or beneficial
89
+ ownership of such entity.
90
+
91
+ 2. License Grants and Conditions
92
+ --------------------------------
93
+
94
+ 2.1. Grants
95
+
96
+ Each Contributor hereby grants You a world-wide, royalty-free,
97
+ non-exclusive license:
98
+
99
+ (a) under intellectual property rights (other than patent or trademark)
100
+ Licensable by such Contributor to use, reproduce, make available,
101
+ modify, display, perform, distribute, and otherwise exploit its
102
+ Contributions, either on an unmodified basis, with Modifications, or
103
+ as part of a Larger Work; and
104
+
105
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
106
+ for sale, have made, import, and otherwise transfer either its
107
+ Contributions or its Contributor Version.
108
+
109
+ 2.2. Effective Date
110
+
111
+ The licenses granted in Section 2.1 with respect to any Contribution
112
+ become effective for each Contribution on the date the Contributor first
113
+ distributes such Contribution.
114
+
115
+ 2.3. Limitations on Grant Scope
116
+
117
+ The licenses granted in this Section 2 are the only rights granted under
118
+ this License. No additional rights or licenses will be implied from the
119
+ distribution or licensing of Covered Software under this License.
120
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
121
+ Contributor:
122
+
123
+ (a) for any code that a Contributor has removed from Covered Software;
124
+ or
125
+
126
+ (b) for infringements caused by: (i) Your and any other third party's
127
+ modifications of Covered Software, or (ii) the combination of its
128
+ Contributions with other software (except as part of its Contributor
129
+ Version); or
130
+
131
+ (c) under Patent Claims infringed by Covered Software in the absence of
132
+ its Contributions.
133
+
134
+ This License does not grant any rights in the trademarks, service marks,
135
+ or logos of any Contributor (except as may be necessary to comply with
136
+ the notice requirements in Section 3.4).
137
+
138
+ 2.4. Subsequent Licenses
139
+
140
+ No Contributor makes additional grants as a result of Your choice to
141
+ distribute the Covered Software under a subsequent version of this
142
+ License (see Section 10.2) or under the terms of a Secondary License (if
143
+ permitted under the terms of Section 3.3).
144
+
145
+ 2.5. Representation
146
+
147
+ Each Contributor represents that the Contributor believes its
148
+ Contributions are its original creation(s) or it has sufficient rights
149
+ to grant the rights to its Contributions conveyed by this License.
150
+
151
+ 2.6. Fair Use
152
+
153
+ This License is not intended to limit any rights You have under
154
+ applicable copyright doctrines of fair use, fair dealing, or other
155
+ equivalents.
156
+
157
+ 2.7. Conditions
158
+
159
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
160
+ in Section 2.1.
161
+
162
+ 3. Responsibilities
163
+ -------------------
164
+
165
+ 3.1. Distribution of Source Form
166
+
167
+ All distribution of Covered Software in Source Code Form, including any
168
+ Modifications that You create or to which You contribute, must be under
169
+ the terms of this License. You must inform recipients that the Source
170
+ Code Form of the Covered Software is governed by the terms of this
171
+ License, and how they can obtain a copy of this License. You may not
172
+ attempt to alter or restrict the recipients' rights in the Source Code
173
+ Form.
174
+
175
+ 3.2. Distribution of Executable Form
176
+
177
+ If You distribute Covered Software in Executable Form then:
178
+
179
+ (a) such Covered Software must also be made available in Source Code
180
+ Form, as described in Section 3.1, and You must inform recipients of
181
+ the Executable Form how they can obtain a copy of such Source Code
182
+ Form by reasonable means in a timely manner, at a charge no more
183
+ than the cost of distribution to the recipient; and
184
+
185
+ (b) You may distribute such Executable Form under the terms of this
186
+ License, or sublicense it under different terms, provided that the
187
+ license for the Executable Form does not attempt to limit or alter
188
+ the recipients' rights in the Source Code Form under this License.
189
+
190
+ 3.3. Distribution of a Larger Work
191
+
192
+ You may create and distribute a Larger Work under terms of Your choice,
193
+ provided that You also comply with the requirements of this License for
194
+ the Covered Software. If the Larger Work is a combination of Covered
195
+ Software with a work governed by one or more Secondary Licenses, and the
196
+ Covered Software is not Incompatible With Secondary Licenses, this
197
+ License permits You to additionally distribute such Covered Software
198
+ under the terms of such Secondary License(s), so that the recipient of
199
+ the Larger Work may, at their option, further distribute the Covered
200
+ Software under the terms of either this License or such Secondary
201
+ License(s).
202
+
203
+ 3.4. Notices
204
+
205
+ You may not remove or alter the substance of any license notices
206
+ (including copyright notices, patent notices, disclaimers of warranty,
207
+ or limitations of liability) contained within the Source Code Form of
208
+ the Covered Software, except that You may alter any license notices to
209
+ the extent required to remedy known factual inaccuracies.
210
+
211
+ 3.5. Application of Additional Terms
212
+
213
+ You may choose to offer, and to charge a fee for, warranty, support,
214
+ indemnity or liability obligations to one or more recipients of Covered
215
+ Software. However, You may do so only on Your own behalf, and not on
216
+ behalf of any Contributor. You must make it absolutely clear that any
217
+ such warranty, support, indemnity, or liability obligation is offered by
218
+ You alone, and You hereby agree to indemnify every Contributor for any
219
+ liability incurred by such Contributor as a result of warranty, support,
220
+ indemnity or liability terms You offer. You may include additional
221
+ disclaimers of warranty and limitations of liability specific to any
222
+ jurisdiction.
223
+
224
+ 4. Inability to Comply Due to Statute or Regulation
225
+ ---------------------------------------------------
226
+
227
+ If it is impossible for You to comply with any of the terms of this
228
+ License with respect to some or all of the Covered Software due to
229
+ statute, judicial order, or regulation then You must: (a) comply with
230
+ the terms of this License to the maximum extent possible; and (b)
231
+ describe the limitations and the code they affect. Such description must
232
+ be placed in a text file included with all distributions of the Covered
233
+ Software under this License. Except to the extent prohibited by statute
234
+ or regulation, such description must be sufficiently detailed for a
235
+ recipient of ordinary skill to be able to understand it.
236
+
237
+ 5. Termination
238
+ --------------
239
+
240
+ 5.1. The rights granted under this License will terminate automatically
241
+ if You fail to comply with any of its terms. However, if You become
242
+ compliant, then the rights granted under this License from a particular
243
+ Contributor are reinstated (a) provisionally, unless and until such
244
+ Contributor explicitly and finally terminates Your grants, and (b) on an
245
+ ongoing basis, if such Contributor fails to notify You of the
246
+ non-compliance by some reasonable means prior to 60 days after You have
247
+ come back into compliance. Moreover, Your grants from a particular
248
+ Contributor are reinstated on an ongoing basis if such Contributor
249
+ notifies You of the non-compliance by some reasonable means, this is the
250
+ first time You have received notice of non-compliance with this License
251
+ from such Contributor, and You become compliant prior to 30 days after
252
+ Your receipt of the notice.
253
+
254
+ 5.2. If You initiate litigation against any entity by asserting a patent
255
+ infringement claim (excluding declaratory judgment actions,
256
+ counter-claims, and cross-claims) alleging that a Contributor Version
257
+ directly or indirectly infringes any patent, then the rights granted to
258
+ You by any and all Contributors for the Covered Software under Section
259
+ 2.1 of this License shall terminate.
260
+
261
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
262
+ end user license agreements (excluding distributors and resellers) which
263
+ have been validly granted by You or Your distributors under this License
264
+ prior to termination shall survive termination.
265
+
266
+ ************************************************************************
267
+ * *
268
+ * 6. Disclaimer of Warranty *
269
+ * ------------------------- *
270
+ * *
271
+ * Covered Software is provided under this License on an "as is" *
272
+ * basis, without warranty of any kind, either expressed, implied, or *
273
+ * statutory, including, without limitation, warranties that the *
274
+ * Covered Software is free of defects, merchantable, fit for a *
275
+ * particular purpose or non-infringing. The entire risk as to the *
276
+ * quality and performance of the Covered Software is with You. *
277
+ * Should any Covered Software prove defective in any respect, You *
278
+ * (not any Contributor) assume the cost of any necessary servicing, *
279
+ * repair, or correction. This disclaimer of warranty constitutes an *
280
+ * essential part of this License. No use of any Covered Software is *
281
+ * authorized under this License except under this disclaimer. *
282
+ * *
283
+ ************************************************************************
284
+
285
+ ************************************************************************
286
+ * *
287
+ * 7. Limitation of Liability *
288
+ * -------------------------- *
289
+ * *
290
+ * Under no circumstances and under no legal theory, whether tort *
291
+ * (including negligence), contract, or otherwise, shall any *
292
+ * Contributor, or anyone who distributes Covered Software as *
293
+ * permitted above, be liable to You for any direct, indirect, *
294
+ * special, incidental, or consequential damages of any character *
295
+ * including, without limitation, damages for lost profits, loss of *
296
+ * goodwill, work stoppage, computer failure or malfunction, or any *
297
+ * and all other commercial damages or losses, even if such party *
298
+ * shall have been informed of the possibility of such damages. This *
299
+ * limitation of liability shall not apply to liability for death or *
300
+ * personal injury resulting from such party's negligence to the *
301
+ * extent applicable law prohibits such limitation. Some *
302
+ * jurisdictions do not allow the exclusion or limitation of *
303
+ * incidental or consequential damages, so this exclusion and *
304
+ * limitation may not apply to You. *
305
+ * *
306
+ ************************************************************************
307
+
308
+ 8. Litigation
309
+ -------------
310
+
311
+ Any litigation relating to this License may be brought only in the
312
+ courts of a jurisdiction where the defendant maintains its principal
313
+ place of business and such litigation shall be governed by laws of that
314
+ jurisdiction, without reference to its conflict-of-law provisions.
315
+ Nothing in this Section shall prevent a party's ability to bring
316
+ cross-claims or counter-claims.
317
+
318
+ 9. Miscellaneous
319
+ ----------------
320
+
321
+ This License represents the complete agreement concerning the subject
322
+ matter hereof. If any provision of this License is held to be
323
+ unenforceable, such provision shall be reformed only to the extent
324
+ necessary to make it enforceable. Any law or regulation which provides
325
+ that the language of a contract shall be construed against the drafter
326
+ shall not be used to construe this License against a Contributor.
327
+
328
+ 10. Versions of the License
329
+ ---------------------------
330
+
331
+ 10.1. New Versions
332
+
333
+ Mozilla Foundation is the license steward. Except as provided in Section
334
+ 10.3, no one other than the license steward has the right to modify or
335
+ publish new versions of this License. Each version will be given a
336
+ distinguishing version number.
337
+
338
+ 10.2. Effect of New Versions
339
+
340
+ You may distribute the Covered Software under the terms of the version
341
+ of the License under which You originally received the Covered Software,
342
+ or under the terms of any subsequent version published by the license
343
+ steward.
344
+
345
+ 10.3. Modified Versions
346
+
347
+ If you create software not governed by this License, and you want to
348
+ create a new license for such software, you may create and use a
349
+ modified version of this License if you rename the license and remove
350
+ any references to the name of the license steward (except to note that
351
+ such modified license differs from this License).
352
+
353
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
354
+ Licenses
355
+
356
+ If You choose to distribute Source Code Form that is Incompatible With
357
+ Secondary Licenses under the terms of this version of the License, the
358
+ notice described in Exhibit B of this License must be attached.
359
+
360
+ Exhibit A - Source Code Form License Notice
361
+ -------------------------------------------
362
+
363
+ This Source Code Form is subject to the terms of the Mozilla Public
364
+ License, v. 2.0. If a copy of the MPL was not distributed with this
365
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
366
+
367
+ If it is not possible or desirable to put the notice in a particular
368
+ file, then You may include the notice in a location (such as a LICENSE
369
+ file in a relevant directory) where a recipient would be likely to look
370
+ for such a notice.
371
+
372
+ You may add additional accurate notices of copyright ownership.
373
+
374
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
375
+ ---------------------------------------------------------
376
+
377
+ This Source Code Form is "Incompatible With Secondary Licenses", as
378
+ defined by the Mozilla Public License, v. 2.0.
379
+
380
+ Project-URL: Homepage, https://github.com/sunrenn/objxp
381
+ Keywords: dir,vars,debug
382
+ Classifier: License :: OSI Approved :: MIT License
383
+ Classifier: Programming Language :: Python
384
+ Classifier: Programming Language :: Python :: 3
385
+ Classifier: Development Status :: 4 - Beta
386
+ Classifier: Environment :: Win32 (MS Windows)
387
+ Classifier: Environment :: Console
388
+ Classifier: Natural Language :: Chinese (Simplified)
389
+ Classifier: Natural Language :: English
390
+ Classifier: Topic :: Software Development :: Documentation
391
+ Requires-Python: >=3.9
392
+ Description-Content-Type: text/markdown
393
+ License-File: LICENSE
394
+ Dynamic: license-file
395
+
396
+ # objxp
397
+
398
+ a util for python beginner.
399
+
400
+ objxp is a util to check what members in a object or Class or module imported.
401
+
402
+
403
+ ## Installation
404
+
405
+ You can install objxp from [PyPI](https://pypi.org/project/objxp/):
406
+
407
+ ```bash
408
+ pip install objxp
409
+ ```
410
+
411
+ objxp is supported on Python 3.7 and above.
412
+
413
+ ## How to use
414
+
415
+ There is only 1 function: ox(), with 2 parameters, `savefile`, `ifprint`
416
+
417
+ savefile: "md", "json" or "both", the result str will be saved into "./objxp.md(.json)", defult value is `None`.
418
+
419
+ ifprint: if you dont want to output result on screen, you could give a `false` value to `ifprint`, which defult value is `true`.
420
+
421
+
422
+ ## Usage Example
423
+
424
+ ### example.py
425
+
426
+ ```python
427
+
428
+ from objxp import ox
429
+
430
+ ox(print,savefile:str,ifprint:bool)
431
+
432
+ ```
433
+ ### output
434
+
435
+ It will output the members of function `print` on the screen as below:
436
+
437
+ ```bash
438
+ _________________________
439
+
440
+ <class 'builtin_function_or_method'>
441
+
442
+ <built-in function print>
443
+ _________________________
444
+
445
+ <class 'NoneType'>
446
+ __text_signature__,
447
+
448
+ <class 'builtin_function_or_method'>
449
+ __dir__, __format__, __init_subclass__, __new__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__,
450
+
451
+ <class 'method-wrapper'>
452
+ __call__, __delattr__, __eq__, __ge__, __getattribute__, __gt__, __hash__, __init__, __le__, __lt__, __ne__, __repr__, __setattr__, __str__,
453
+
454
+ <class 'module'>
455
+ __self__,
456
+
457
+ <class 'str'>
458
+ __doc__, __module__, __name__, __qualname__,
459
+
460
+ <class 'type'>
461
+ __class__,
462
+
463
+ "\n_________________________\n\n<class 'builtin_function_or_method'>\n\n<built-in function print>\n_________________________\n\n<class 'NoneType'>\n__text_signature__, \n\n<class 'builtin_function_or_method'>\n__dir__, __format__, __init_subclass__, __new__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__, \n\n<class 'method-wrapper'>\n__call__, __delattr__, __eq__, __ge__, __getattribute__, __gt__, __hash__, __init__, __le__, __lt__, __ne__, __repr__, __setattr__, __str__, \n\n<class 'module'>\n__self__, \n\n<class 'str'>\n__doc__, __module__, __name__, __qualname__, \n\n<class 'type'>\n__class__, \n"
464
+
465
+ ```
@@ -0,0 +1,8 @@
1
+ objxp/__init__.py,sha256=THJUYXGgxQpQCLpkYWG4sX8OClMFEztINfol8SNLz3Y,8837
2
+ objxp/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
+ objxp-1.dist-info/licenses/LICENSE,sha256=kiHC-TYVm4RG0ykkn7TA8lvlEPRHODoPEzNqx5hWaKM,17099
4
+ objxp-1.dist-info/METADATA,sha256=FMPY5XvtsnV5avaDfG6pITUuI50TKt_OA-Kd0F8HKMs,22967
5
+ objxp-1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
6
+ objxp-1.dist-info/entry_points.txt,sha256=pStM4IRndteyj3ltLo0YpB6sf-JjXp4p_LBLRBZWmVE,46
7
+ objxp-1.dist-info/top_level.txt,sha256=rrBimo5TDZPhKfX7pe0CsAC_voov8miukARp5-YH2hk,6
8
+ objxp-1.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (80.9.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ tstox = objxp.__main__:main
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
@@ -0,0 +1 @@
1
+ objxp