Python-VBA函数之旅-dir函数

目录

1、dir函数：

1-1、Python：

1-2、VBA：

2、相关文章：

个人主页：非风V非雨-CSDN博客


        dir函数在 Python 中是一个非常实用的内置函数，它可以在多种场景下被使用。常见应用场景有：

1、交互式探索：当你在Python交互式解释器或Jupyter Notebook中工作时，dir()函数可以帮助你快速了解一个对象有哪些属性和方法。尤其是你刚开始使用一个新的库或模块时特别有用。

2、检查对象的属性和方法：对于自定义的类或对象，你可以使用 `dir()` 来检查它们的属性和方法。

3、结合getattr和setattr使用：当你想要动态地获取或设置对象的属性时，可以组合使用dir()、getattr()和setattr()三个函数。其中，getattr()用于获取对象的属性值，而setattr()用于设置对象的属性值。

4、自动化测试和文档生成：在编写自动化测试或生成文档时，dir()函数可以帮助你获取对象的所有属性和方法，从而可以编写更全面的测试用例或生成更完整的文档。

5、调试和排查：当你遇到对象的行为不符合预期时，可以使用dir()函数来检查对象的属性或方法是否存在或是否已被正确设置。

6、过滤和排序属性：dir()函数返回的是一个包含所有属性和方法名称的列表，你可以使用 Python 的列表操作来过滤和排序这些属性。例如，你可能只对类的方法感兴趣，并希望按字母顺序对它们进行排序。

7、自定义 `__dir__` 方法：对于自定义的类，你可以通过实现 `__dir__` 方法来定制 dir()函数的行为。这允许你控制哪些属性或方法应该被dir()函数列出。

8、元编程和动态类型检查：dir()函数可以用来检查对象是否实现了特定的接口或遵循了某些约定，这对于构建灵活且可扩展的系统非常有用。

        总之，了解并掌握这些用法和技巧，可以帮助你更高效地利用dir()函数，并在 Python 编程中更深入地理解对象和其结构。然而，也要注意不要过度依赖dir()，因为过度使用可能会使代码变得难以阅读和维护。

1、dir函数：
1-1、Python：
  1. # 1.函数：dir
  2. # 2.功能：获取名字或属性、方法的列表
  3. # 3.语法：dir([object])
  4. # 4.参数：object，对象，可选。Python内置了一些基本的对象类型，包括但不限于：
  5. # 4-1、 数字(Numbers):
  6.     # int：整数
  7.     # float：浮点数
  8.     # complex：复数
  9. # 4-2、 序列(Sequences):
  10.     # list：列表，可以包含任意类型的元素
  11.     # tuple：元组，与列表类似但不可变
  12.     # str：字符串，字符序列
  13.     # bytes：字节序列
  14.     # bytearray：可变字节序列
  15.     # memoryview：内存视图，是原始数据的不同解释
  16. # 4-3、集合(Sets):
  17.     # set：无序且不包含重复元素的集合
  18.     # frozenset：不可变的集合
  19. # 4-4、映射(Mappings):
  20.     # dict：字典，键值对映射
  21. # 4-5、布尔值(Booleans):
  22.     # bool：布尔类型，只有两个值:True和False
  23. # 4-6、类型(Types):
  24.     # type：类型对象，用于描述其他对象的数据类型
  25. # 4-7、其他内置类型:
  26.     # NoneType：只有一个值None，表示空或没有值
  27.     # ellipsis：...，通常用于切片操作或表示省略
  28.     # slice：表示切片对象，用于切片操作
  29.     # range：表示不可变的整数序列，通常用于循环
  30.     # property：用于获取、设置或删除属性的内置装饰器类型
  31.     # function：函数对象
  32.     # method：方法对象，即绑定到类实例的函数
  33.     # classmethod和staticmethod：特殊的方法类型，分别表示类方法和静态方法
  34.     # module：模块对象
  35.     # traceback、frame和code：与异常和调试相关的对象
  36. # 5.返回值：
  37. # 5-1、无实参：返回当前本地作用域中的名称列表
  38. # 5-2、有实参：返回所有属性和方法，甚至是所有对象默认的内置属性
  39. # 6.说明：
  40. # 6-1、返回列表的顺序：dir()函数返回的列表并不保证特定的顺序。这意味着，每次调用dir()函数时，即使是对同一个对象，返回的属性列表的顺序也可能不同。
  41. #      因此，不应该依赖dir()函数返回的顺序进行任何逻辑操作。
  42. # 6-2、包含的内容：dir()函数返回的列表包含了对象的所有属性，包括方法、变量、模块等。这包括了一些可能并不直接对用户有用的特殊方法(如`__init__`、`__call__`等)或内部使用的属性。
  43. #      因此，在使用dir()函数返回的结果时，通常需要过滤出你真正关心的属性。
  44. # 6-3、动态属性：如果对象在运行时动态地添加或删除了属性，那么dir()函数的结果也会相应地改变。这意味着，如果你在一个时间点调用了dir()，
  45. #      然后在另一个时间点再次调用，结果可能会有所不同。
  46. # 6-4、私有属性：虽然dir()函数会返回对象的所有属性，包括以单个下划线`_`开头的“保护”属性和以双下划线`__`开头的“私有”属性，但通常不建议直接访问这些属性，
  47. #      因为它们可能是类内部使用的，并且可能在未来的版本中发生变化。
  48. # 6-5、继承的属性：如果对象是从其他类继承的，那么dir()函数返回的列表也会包括继承的属性。这意味着，你可能需要过滤掉一些你不关心的、从父类继承的属性。
  49. # 6-6、性能考虑：对于大型对象或复杂的对象结构，dir()函数可能会花费一些时间来收集所有的属性。在性能敏感的应用中，频繁调用dir()函数可能会对性能产生负面影响。
  50. # 6-7、替代方法：在某些情况下，你可能不需要使用dir()函数。例如，如果你只是想知道一个对象是否有一个特定的属性或方法，可以使用hasattr()函数；
  51. #      同样，你可以使用getattr()来获取一个属性的值，或者使用setattr()来设置一个属性的值。
  52. # 7.示例：
  53. # 应用1：交互式探索
  54. import pandas as pd
  55. print(dir(pd))
  56. # ['ArrowDtype', 'BooleanDtype', 'Categorical', 'CategoricalDtype', 'CategoricalIndex', 'DataFrame', 'DateOffset',
  57. # 'DatetimeIndex', 'DatetimeTZDtype', 'ExcelFile', 'ExcelWriter', 'Flags', 'Float32Dtype', 'Float64Dtype', 'Grouper',
  58. # 'HDFStore', 'Index', 'IndexSlice', 'Int16Dtype', 'Int32Dtype', 'Int64Dtype', 'Int8Dtype', 'Interval', 'IntervalDtype',
  59. # 'IntervalIndex', 'MultiIndex', 'NA', 'NaT', 'NamedAgg', 'Period', 'PeriodDtype', 'PeriodIndex', 'RangeIndex', 'Series',
  60. # 'SparseDtype', 'StringDtype', 'Timedelta', 'TimedeltaIndex', 'Timestamp', 'UInt16Dtype', 'UInt32Dtype', 'UInt64Dtype',
  61. # 'UInt8Dtype', '__all__', '__builtins__', '__cached__', '__doc__', '__docformat__', '__file__', '__git_version__',
  62. # '__loader__', '__name__', '__package__', '__path__', '__spec__', '__version__', '_built_with_meson', '_config',
  63. # '_is_numpy_dev', '_libs', '_pandas_datetime_CAPI', '_pandas_parser_CAPI', '_testing', '_typing', '_version_meson',
  64. # 'annotations', 'api', 'array', 'arrays', 'bdate_range', 'compat', 'concat', 'core', 'crosstab', 'cut', 'date_range',
  65. # 'describe_option', 'errors', 'eval', 'factorize', 'from_dummies', 'get_dummies', 'get_option', 'infer_freq',
  66. # 'interval_range', 'io', 'isna', 'isnull', 'json_normalize', 'lreshape', 'melt', 'merge', 'merge_asof', 'merge_ordered',
  67. # 'notna', 'notnull', 'offsets', 'option_context', 'options', 'pandas', 'period_range', 'pivot', 'pivot_table', 'plotting',
  68. # 'qcut', 'read_clipboard', 'read_csv', 'read_excel', 'read_feather', 'read_fwf', 'read_gbq', 'read_hdf', 'read_html',
  69. # 'read_json', 'read_orc', 'read_parquet', 'read_pickle', 'read_sas', 'read_spss', 'read_sql', 'read_sql_query',
  70. # 'read_sql_table', 'read_stata', 'read_table', 'read_xml', 'reset_option', 'set_eng_float_format', 'set_option',
  71. # 'show_versions', 'test', 'testing', 'timedelta_range', 'to_datetime', 'to_numeric', 'to_pickle', 'to_timedelta',
  72. # 'tseries', 'unique', 'util', 'value_counts', 'wide_to_long']
  73.  
  74. import math
  75. print(dir(math))
  76. # ['__doc__', '__loader__', '__name__', '__package__', '__spec__', 'acos', 'acosh', 'asin', 'asinh', 'atan', 'atan2',
  77. #  'atanh', 'cbrt', 'ceil', 'comb', 'copysign', 'cos', 'cosh', 'degrees', 'dist', 'e', 'erf', 'erfc', 'exp', 'exp2',
  78. #  'expm1', 'fabs', 'factorial', 'floor', 'fmod', 'frexp', 'fsum', 'gamma', 'gcd', 'hypot', 'inf', 'isclose', 'isfinite',
  79. #  'isinf', 'isnan', 'isqrt', 'lcm', 'ldexp', 'lgamma', 'log', 'log10', 'log1p', 'log2', 'modf', 'nan', 'nextafter',
  80. #  'perm', 'pi', 'pow', 'prod', 'radians', 'remainder', 'sin', 'sinh', 'sqrt', 'tan', 'tanh', 'tau', 'trunc', 'ulp']
  81.  
  82. import cmath
  83. print(dir(cmath))
  84. # ['__doc__', '__loader__', '__name__', '__package__', '__spec__', 'acos', 'acosh', 'asin', 'asinh', 'atan', 'atanh',
  85. # 'cos', 'cosh', 'e', 'exp', 'inf', 'infj', 'isclose', 'isfinite', 'isinf', 'isnan', 'log', 'log10', 'nan', 'nanj',
  86. # 'phase', 'pi', 'polar', 'rect', 'sin', 'sinh', 'sqrt', 'tan', 'tanh', 'tau']
  87.  
  88. # 应用2：检查对象的属性和方法
  89. class MyClass:
  90.     def __init__(self):
  91.         self.my_var = 42
  92.     def my_method(self):
  93.         print("This is a method.")
  94. obj = MyClass()
  95. print(dir(obj))
  96. # ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__',
  97. # '__getstate__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__',
  98. # '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__',
  99. # '__weakref__', 'my_method', 'my_var']
  100.  
  101. # 应用3：结合getattr和setattr使用
  102. class MyClass:
  103.     def __init__(self):
  104.         self.my_var = 42
  105. if __name__ == '__main__':
  106.     obj = MyClass()
  107.     for attr in dir(obj):
  108.         if not attr.startswith('__'):  # 排除特殊方法或属性
  109.             value = getattr(obj, attr)
  110.             print(f"{attr}: {value}")
  111.     # 设置属性
  112.     setattr(obj, 'new_var', 100)
  113. # my_var: 42
  114.  
  115. # 应用4：自动化测试和文档生成
  116. import math
  117. def write_module_docs(module):
  118.     with open('module_docs.txt', 'w') as f:
  119.         f.write(f"Attributes and methods in {module.__name__}:\n")
  120.         for attr in dir(module):
  121.             if not attr.startswith("_"):  # 排除私有属性
  122.                 f.write(f"- {attr}\n")
  123. if __name__ == '__main__':
  124.     write_module_docs(math)  # 为math模块生成文档
  125.  
  126. # 应用5：调试和排查
  127. print(dir(complex))
  128. # ['__abs__', '__add__', '__bool__', '__class__', '__complex__', '__delattr__', '__dir__', '__doc__', '__eq__',
  129. # '__format__', '__ge__', '__getattribute__', '__getnewargs__', '__getstate__', '__gt__', '__hash__', '__init__',
  130. # '__init_subclass__', '__le__', '__lt__', '__mul__', '__ne__', '__neg__', '__new__', '__pos__', '__pow__', '__radd__',
  131. # '__reduce__', '__reduce_ex__', '__repr__', '__rmul__', '__rpow__', '__rsub__', '__rtruediv__', '__setattr__',
  132. # '__sizeof__', '__str__', '__sub__', '__subclasshook__', '__truediv__', 'conjugate', 'imag', 'real']
  133.  
  134. # 应用6：过滤和排序属性
  135. class MyClass:
  136.     def method1(self):
  137.         pass
  138.     def method2(self):
  139.         pass
  140. if __name__ == '__main__':
  141.     methods = [attr for attr in dir(MyClass) if callable(getattr(MyClass, attr)) and attr.startswith('method')]
  142.     methods.sort()
  143.     print(methods)
  144. # ['method1', 'method2']
  145.  
  146. # 应用7：自定义 `__dir__` 方法
  147. class MyClass:
  148.     def __init__(self):
  149.         self.a = 3
  150.         self.b = 5
  151.         self.c = 10
  152.     def __dir__(self):
  153.         return ['a', 'c']
  154. if __name__ == '__main__':
  155.     obj = MyClass()
  156.     print(dir(obj))
  157. # ['a', 'c']
  158.  
  159. # 应用8：元编程和动态类型检查
  160. # 元编程
  161. class MyClass:
  162.     def __init__(self):
  163.         self.attribute1 = "Hello"
  164.         self.attribute2 = "Python"
  165.     def method1(self):
  166.         print("This is method 1")
  167.     def method2(self):
  168.         print("This is method 2")
  169. # 主函数
  170. if __name__ == '__main__':
  171.     obj = MyClass()
  172.     # 使用dir函数获取对象的所有属性和方法
  173.     attributes_and_methods = dir(obj)
  174.     # 打印所有属性和方法
  175.     print("Attributes and methods of MyClass instance:")
  176.     for item in attributes_and_methods:
  177.         print(item)
  178. # Attributes and methods of MyClass instance:
  179. # __class__
  180. # __delattr__
  181. # __dict__
  182. # __dir__
  183. # __doc__
  184. # __eq__
  185. # __format__
  186. # __ge__
  187. # __getattribute__
  188. # __getstate__
  189. # __gt__
  190. # __hash__
  191. # __init__
  192. # __init_subclass__
  193. # __le__
  194. # __lt__
  195. # __module__
  196. # __ne__
  197. # __new__
  198. # __reduce__
  199. # __reduce_ex__
  200. # __repr__
  201. # __setattr__
  202. # __sizeof__
  203. # __str__
  204. # __subclasshook__
  205. # __weakref__
  206. # attribute1
  207. # attribute2
  208. # method1
  209. # method2
  210.  
  211. #动态类型检查
  212. def is_instance_of_class(obj, class_name):
  213.     # 获取对象的所有属性和方法
  214.     obj_attributes = dir(obj)
  215.     # 获取类的所有属性和方法
  216.     class_attributes = dir(class_name)
  217.     # 检查对象的所有属性和方法是否都是类的属性和方法的子集
  218.     return set(obj_attributes).issubset(set(class_attributes))
  219. class MyClass:
  220.     pass
  221. if __name__ == '__main__':
  222.     obj = MyClass()
  223.     # 检查obj是否是MyClass的实例
  224.     if is_instance_of_class(obj, MyClass):
  225.         print("obj is an instance of MyClass")
  226.     else:
  227.         print("obj is not an instance of MyClass")
  228. # obj is an instance of MyClass
1-2、VBA：
略，待后补。
2、相关文章：

2-1、Python-VBA函数之旅-bytes()函数 

2-2、Python-VBA函数之旅-callable()函数

2-3、Python-VBA函数之旅-classmethod()函数 

2-4、Python-VBA函数之旅-compile()函数 

Python算法之旅：Algorithm

Python函数之旅：Functions 

个人主页：非风V非雨-CSDN博客
文章知识点与官方知识档案匹配，可进一步学习相关知识
算法技能树首页概览61139 人正在系统学习中
遨游码海，我心飞扬
微信名片
注：本文转载自blog.csdn.net的神奇夜光杯的文章"https://myelsa1024.blog.csdn.net/article/details/137791856"。版权归原作者所有，此博客不拥有其著作权，亦不承担相应法律责任。如有侵权，请联系我们删除。
复制链接
相关推荐
发表评论

评论记录：

未查询到任何数据！