Missing docstrings

[sajith]

There still are several methods and classes that should have docstrings, but do not.

Run either pylint --disable=all --enable=missing-docstring fabrictestbed_extensions/fablib/ or interrogate -vv fabrictestbed_extensions/fablib/ for a list of missing docstrings.

The previous issue #235 was automatically closed when an associated PR was merged. It might be a good idea to add a CI check to avoid future docstring coverage drops.

Here are some child issues, just so that the resulting PRs are smaller and we do not accidentally close this meta-ticket when the linked PR gets merged:

• Add missing function docstrings in fablib.interface #313
• Add missing function docstrings in fablib.network_service #314
• Add missing function docstrings in fablib.resources #315
• Add missing function docstrings in fablib.slice #316
• Add missing function docstrings in fablib.component #317
• Add missing function docstrings in fablib.node #318
• Add missing function docstrings in fablib.fablib #319
• Add missing function docstrings in fablib.config.config #320

[sajith]

Below is a quick list of methods with missing docstrings, produced with pylint --disable=all --enable=missing-function-docstring fabrictestbed_extensions/fablib --output-format=parseable --msg-template="{path}:{obj}".

Some of these methods probably should be private. I'm not sure if/how we can add _ prefixes to them without breaking backward compatibility. Hopefully no one has used them in their Jupyter notebooks or project code.

It might be easier to add docstrings in separate PRs, module by module.

************* Module fabrictestbed_extensions.fablib.component
fabrictestbed_extensions/fablib/component.py:Component.get_fablib_manager
fabrictestbed_extensions/fablib/component.py:Component.get_pretty_name_dict
fabrictestbed_extensions/fablib/component.py:Component.generate_template_context
fabrictestbed_extensions/fablib/component.py:Component.get_template_context
fabrictestbed_extensions/fablib/component.py:Component.render_template
fabrictestbed_extensions/fablib/component.py:Component.get_short_name
fabrictestbed_extensions/fablib/component.py:Component.get_fim
fabrictestbed_extensions/fablib/component.py:Component.set_user_data
fabrictestbed_extensions/fablib/component.py:Component.get_user_data
fabrictestbed_extensions/fablib/component.py:Component.delete
************* Module fabrictestbed_extensions.fablib.facility_port
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.toJson
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.get_pretty_name_dict
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.toDict
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.get_template_context
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.render_template
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.show
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.get_fim_interface
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.get_model
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.get_site
fabrictestbed_extensions/fablib/facility_port.py:FacilityPort.new_facility_port
************* Module fabrictestbed_extensions.fablib.network_service
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_pretty_name_dict
fabrictestbed_extensions/fablib/network_service.py:NetworkService.generate_template_context
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_template_context
fabrictestbed_extensions/fablib/network_service.py:NetworkService.render_template
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_fablib_manager
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_site
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_sliver
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_fim
fabrictestbed_extensions/fablib/network_service.py:NetworkService.set_user_data
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_user_data
fabrictestbed_extensions/fablib/network_service.py:NetworkService.add_interface
fabrictestbed_extensions/fablib/network_service.py:NetworkService.remove_interface
fabrictestbed_extensions/fablib/network_service.py:NetworkService.delete
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_fablib_data
fabrictestbed_extensions/fablib/network_service.py:NetworkService.set_fablib_data
fabrictestbed_extensions/fablib/network_service.py:NetworkService.set_subnet
fabrictestbed_extensions/fablib/network_service.py:NetworkService.set_gateway
fabrictestbed_extensions/fablib/network_service.py:NetworkService.get_allocated_ips
fabrictestbed_extensions/fablib/network_service.py:NetworkService.set_allocated_ip
fabrictestbed_extensions/fablib/network_service.py:NetworkService.allocate_ip
fabrictestbed_extensions/fablib/network_service.py:NetworkService.set_allocated_ips
fabrictestbed_extensions/fablib/network_service.py:NetworkService.free_ip
fabrictestbed_extensions/fablib/network_service.py:NetworkService.make_ip_publicly_routable
fabrictestbed_extensions/fablib/network_service.py:NetworkService.init_fablib_data
fabrictestbed_extensions/fablib/network_service.py:NetworkService.is_instantiated
fabrictestbed_extensions/fablib/network_service.py:NetworkService.set_instantiated
fabrictestbed_extensions/fablib/network_service.py:NetworkService.config
************* Module fabrictestbed_extensions.fablib.node
fabrictestbed_extensions/fablib/node.py:Node.get_fablib_manager
fabrictestbed_extensions/fablib/node.py:Node.get_pretty_name_dict
fabrictestbed_extensions/fablib/node.py:Node.generate_template_context
fabrictestbed_extensions/fablib/node.py:Node.get_template_context
fabrictestbed_extensions/fablib/node.py:Node.render_template
fabrictestbed_extensions/fablib/node.py:Node.delete
fabrictestbed_extensions/fablib/node.py:Node.get_networks
fabrictestbed_extensions/fablib/node.py:Node.get_paramiko_key
fabrictestbed_extensions/fablib/node.py:Node.get_fim
fabrictestbed_extensions/fablib/node.py:Node.set_user_data
fabrictestbed_extensions/fablib/node.py:Node.get_user_data
fabrictestbed_extensions/fablib/node.py:Node.delete
fabrictestbed_extensions/fablib/node.py:Node.init_fablib_data
fabrictestbed_extensions/fablib/node.py:Node.get_fablib_data
fabrictestbed_extensions/fablib/node.py:Node.set_fablib_data
fabrictestbed_extensions/fablib/node.py:Node.get_routes
fabrictestbed_extensions/fablib/node.py:Node.config_routes
fabrictestbed_extensions/fablib/node.py:Node.run_post_boot_tasks
fabrictestbed_extensions/fablib/node.py:Node.run_post_update_commands
fabrictestbed_extensions/fablib/node.py:Node.is_instantiated
fabrictestbed_extensions/fablib/node.py:Node.set_instantiated
fabrictestbed_extensions/fablib/node.py:Node.run_update_commands
fabrictestbed_extensions/fablib/node.py:Node.set_run_update_commands
************* Module fabrictestbed_extensions.fablib.slice
fabrictestbed_extensions/fablib/slice.py:Slice.get_fablib_manager
fabrictestbed_extensions/fablib/slice.py:Slice.get_pretty_names_dict
fabrictestbed_extensions/fablib/slice.py:Slice.get_template_context
fabrictestbed_extensions/fablib/slice.py:Slice.get_sliver
fabrictestbed_extensions/fablib/slice.py:Slice.get_slivers
fabrictestbed_extensions/fablib/slice.py:Slice.is_dead_or_closing
fabrictestbed_extensions/fablib/slice.py:Slice.isReady
fabrictestbed_extensions/fablib/slice.py:Slice.get_user_data
************* Module fabrictestbed_extensions.fablib.interface
fabrictestbed_extensions/fablib/interface.py:Interface.get_fablib_manager
fabrictestbed_extensions/fablib/interface.py:Interface.get_pretty_name_dict
fabrictestbed_extensions/fablib/interface.py:Interface.get_numa_node
fabrictestbed_extensions/fablib/interface.py:Interface.generate_template_context
fabrictestbed_extensions/fablib/interface.py:Interface.get_template_context
fabrictestbed_extensions/fablib/interface.py:Interface.render_template
fabrictestbed_extensions/fablib/interface.py:Interface.set_auto_config
fabrictestbed_extensions/fablib/interface.py:Interface.unset_auto_config
fabrictestbed_extensions/fablib/interface.py:Interface.get_reservation_id
fabrictestbed_extensions/fablib/interface.py:Interface.get_short_name
fabrictestbed_extensions/fablib/interface.py:Interface.get_ip_addr_show
fabrictestbed_extensions/fablib/interface.py:Interface.get_fim
fabrictestbed_extensions/fablib/interface.py:Interface.set_user_data
fabrictestbed_extensions/fablib/interface.py:Interface.get_user_data
fabrictestbed_extensions/fablib/interface.py:Interface.get_fablib_data
fabrictestbed_extensions/fablib/interface.py:Interface.set_fablib_data
fabrictestbed_extensions/fablib/interface.py:Interface.set_network
fabrictestbed_extensions/fablib/interface.py:Interface.set_ip_addr
fabrictestbed_extensions/fablib/interface.py:Interface.get_ip_addr
fabrictestbed_extensions/fablib/interface.py:Interface.set_mode
fabrictestbed_extensions/fablib/interface.py:Interface.get_mode
fabrictestbed_extensions/fablib/interface.py:Interface.is_configured
fabrictestbed_extensions/fablib/interface.py:Interface.config
fabrictestbed_extensions/fablib/interface.py:Interface.add_mirror
fabrictestbed_extensions/fablib/interface.py:Interface.delete
************* Module fabrictestbed_extensions.fablib.fablib
fabrictestbed_extensions/fablib/fablib.py:fablib.get_default_fablib_manager
fabrictestbed_extensions/fablib/fablib.py:fablib.show_config
fabrictestbed_extensions/fablib/fablib.py:fablib.is_jupyter_notebook
fabrictestbed_extensions/fablib/fablib.py:FablibManager.get_ssh_thread_pool_executor
fabrictestbed_extensions/fablib/fablib.py:FablibManager.show_table_text
fabrictestbed_extensions/fablib/fablib.py:FablibManager.show_table_jupyter
fabrictestbed_extensions/fablib/fablib.py:FablibManager.show_table_json
fabrictestbed_extensions/fablib/fablib.py:FablibManager.show_table_dict
fabrictestbed_extensions/fablib/fablib.py:FablibManager.show_table
fabrictestbed_extensions/fablib/fablib.py:FablibManager.list_table_text
fabrictestbed_extensions/fablib/fablib.py:FablibManager.list_table_jupyter
fabrictestbed_extensions/fablib/fablib.py:FablibManager.list_table_json
fabrictestbed_extensions/fablib/fablib.py:FablibManager.list_table_list
fabrictestbed_extensions/fablib/fablib.py:FablibManager.list_table
fabrictestbed_extensions/fablib/fablib.py:FablibManager.create_list_table
fabrictestbed_extensions/fablib/fablib.py:FablibManager.create_list_tableXXX
fabrictestbed_extensions/fablib/fablib.py:FablibManager.create_show_table
fabrictestbed_extensions/fablib/fablib.py:FablibManager.create_show_tableXXX
************* Module fabrictestbed_extensions.fablib.resources
fabrictestbed_extensions/fablib/resources.py:Resources.get_fablib_manager
fabrictestbed_extensions/fablib/resources.py:Resources.site_to_json
fabrictestbed_extensions/fablib/resources.py:Resources.site_to_dictXXX
fabrictestbed_extensions/fablib/resources.py:Resources.list_sites
************* Module fabrictestbed_extensions.fablib.config.config
fabrictestbed_extensions/fablib/config/config.py:Config.save_config

------------------------------------------------------------------
Your code has been rated at 9.72/10 (previous run: 9.72/10, +0.00)