Documentation/Nightly/Developers/FAQ/Python Scripting - Revision history

Lasso: /* Can I use factory method like CreateNodeByClass or GetNodesByClass ? */

2022-02-04T20:05:03Z

Can I use factory method like CreateNodeByClass or GetNodesByClass ?

2021-08-19T04:35:09Z

How can I use a visual debugger for step-by-step debugging

2021-08-19T03:26:06Z

Debugging using PyCharm or PyDev

2021-08-19T03:25:13Z

Debugging using Visual Studio

2021-04-24T04:12:09Z

2020-12-09T20:50:07Z

How to systematically execute custom python code at startup ?

2020-10-03T03:44:45Z

How to display progress bar for CLI module execution in a scripted module

2020-10-03T03:42:11Z

How to update progress bar in scripted (Python, or other) CLI modules

2020-05-05T05:54:54Z

2019-08-21T15:23:21Z

Adding information about different decorator types and adding links to code source

@@ Line 119: / Line 119: @@
 == How can I use a visual debugger for step-by-step debugging ==
-===Debugging using PyCharm, Visual Studio, Visual Studio Code, PyDev===
+Visual debugging (setting breakpoints, execute code step-by-step, view variables, stack, etc.) of Python scripted module is possible by using various IDEs. See detailed setup instructions [https://slicer.readthedocs.io/en/latest/developer_guide/debugging/overview.html#python-debugging here].
 == Why can't I access my C++ Qt class from python ==

@@ Line 119: / Line 119: @@
 == How can I use a visual debugger for step-by-step debugging ==
-===Debugging using PyCharm or PyDev===
+===Debugging using PyCharm, Visual Studio, Visual Studio Code, PyDev===
 Visual debugging (setting breakpoints, execute code step-by-step, view variables, stack, etc.) of Python scripted module is possible by using [https://www.jetbrains.com/pycharm/ PyCharm] or [http://pydev.org/ PyDev] by using the ''Python debugger'' module [[Documentation/{{documentation/version}}/Extensions/DebuggingTools|Debugging tools]] extension.

@@ Line 124: / Line 124: @@
 '''See detailed instructions at the [[Documentation/{{documentation/version}}/Extensions/DebuggingTools|Debugging tools extension page]].'''
 [[File:PyDevRemoteDebugSlicer.png|800px|thumb|center|Visual debugging of Python modules in Slicer]]
 ===Debugging using remote-pdb===

@@ Line 115: / Line 115: @@
 == Where can I find example scripts? ==
-Have a look at [[Documentation/{{documentation/version}}/ScriptRepository]].
+Have a look at the [https://slicer.readthedocs.io/en/latest/developer_guide/script_repository.html Script repository].
 == How can I use a visual debugger for step-by-step debugging ==

@@ Line 24: / Line 24: @@
 == How to systematically execute custom python code at startup ? ==
-Each time Slicer starts, it will look up for a startup script file named <code>.slicerrc.py</code> in your [[Documentation/{{documentation/version}}/FAQ/General#What_is_my_HOME_folder_.3F|HOME folder]]. Content of this file is executed automatically at each startup of Slicer.
+See https://slicer.readthedocs.io/en/latest/user_guide/settings.html#application-startup-file
 == How to save an image/volume using python ? ==

@@ Line 438: / Line 438: @@
              self.progressBar.close()
 </pre>
 == How to run Python script using a non-Slicer Python environment ==

@@ Line 401: / Line 401: @@
    print("""<filter-end><filter-name>TestFilter</filter-name><filter-time>10</filter-time></filter-end>""")
    sys.stdout.flush()
 </pre>

← Older revision		Revision as of 05:54, 5 May 2020
Line 426:		Line 426:
	print(command_result)		print(command_result)
	</pre>		</pre>
		+
		+	== How to configure network proxy ? ==
		+
		+	When using either <tt>urllib.request</tt> or <tt>requests</tt>, proxy configured by setting <tt>http_proxy</tt> and <tt>https_proxy</tt> environment variables will automatically be used.
		+
		+	For more details:
		+	* https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen
		+	* https://2.python-requests.org/en/master/user/advanced/#proxies

@@ Line 219: / Line 219: @@
 </pre>
-Note: @vtk.calldata_type is a Python decorator, which modifies properties of a function that is declared right after the decorator. The decorator is defined in VTK (in Wrapping\Python\vtk\util\misc.py).
+'''Note''': @vtk.calldata_type is a Python decorator, which modifies properties of a function that is declared right after the decorator. The decorator is defined in VTK (in [https://github.com/Kitware/VTK/blob/master/Wrapping/Python/vtkmodules/util/misc.py Wrapping\Python\vtk\util\misc.py]).
 Usage from a class requires an extra step of creating the callback in the class __init__ function, as Python2 by default does some extra wrapping (http://stackoverflow.com/questions/9523370/adding-attributes-to-instance-methods-in-python):