micropython REPL在线环境中查看文档

看到另外一位写micropython离线文档。这里推荐一下其他的文档查看方式。

第一，下载micropython的pdf文档。大约200多页。

第二，利用micropython REPL的在线文档。

REPL（Read-Evaluate-Print-Loop）是通过命令行逐句执行语句的方式。是小规模学习和评估一种语言的最直接的方式。包括Python在内，许多语言如Lua等都具备REPL接口。

我这里就不截屏了，直接上贴代码。


>>> dir()
['__name__', 'machine', 'pyb', 'a', 'b']

>>> dir(machine)
['__name__', 'info', 'unique_id', 'reset', 'bootloader', 'freq', 'rng', 'idle', 'sleep', 'deepsleep', 'disable_irq', 'enable_irq', 'mem8', 'mem16', 'mem32', 'Pin', 'I2C', 'SPI']

>>> dir(pyb)
['__name__', 'bootloader', 'hard_reset', 'info', 'unique_id', 'freq', 'repl_info', 'wfi', 'disable_irq', 'enable_irq', 'stop', 'standby', 'main', 'repl_uart', 'usb_mode', 'hid_mouse', 'hid_keyboard', 'USB_VCP', 'USB_HID', 'have_cdc', 'hid', 'millis', 'elapsed_millis', 'micros', 'elapsed_micros', 'delay', 'udelay', 'sync', 'mount', 'Timer', 'rng', 'RTC', 'Pin', 'ExtInt', 'pwm', 'servo', 'Servo', 'Switch', 'Flash', 'SD', 'SDCard', 'LED', 'I2C', 'SPI', 'UART', 'CAN', 'ADC', 'ADCAll', 'DAC', 'Accel', 'LCD']

>>> dir(pyb.I2C)
['init', 'deinit', 'is_ready', 'scan', 'send', 'recv', 'mem_read', 'mem_write', 'MASTER', 'SLAVE']
>>> help(pyb.I2C)
object <class 'I2C'> is of type type
  init -- <function>
  deinit -- <function>
  is_ready -- <function>
  scan -- <function>
  send -- <function>
  recv -- <function>
  mem_read -- <function>
  mem_write -- <function>
  MASTER -- 0
  SLAVE -- 1
>>>




在Python REPL中，dir()和help()两个内置函数可以帮助我们了解不少内容。以上就是逐层了解pyb内部类实现的流程。

dir()函数

前面我们已经使用dir()函数来找出模块中定义的名字。它将返回一个排序后的字符串列表，包括变量、模块和函数。

可以使用dir(modname)来了解特定模块的名字。

可以使用不含参数的dir()来了解当前已定义名称。


关于内置函数和变量，Python3中，可以使用dir(__builtins__)来了解。micropython中没有，


help()

基本上是打印Python模块的说明文档：__docstring__。

话说，把文档放在ROM中，好费资源。