- 
- Last revised: November 03, 2023
+Python Module¶
+This module adds a Python interpreter to Eggdrop, allowing you to run Python scripts.
+Loading Python¶
+Put this line into your Eggdrop configuration file to load the python module:
+loadmodule python
+To load a python script from your config file, place the .py file in the scripts/ folder and add the following line to your config:
+pysource scripts/myscript.py
+Partyline Commands¶
+python <expression>¶
+You can run a python command from the partyline with the .python command, such as:
+.python 1 + 1
+Python: 2
+.python from eggdrop.tcl import putmsg; putmsg('#chan', 'Hello world!')
+Python: None
+.binds python¶
+The python module extends the core .binds partyline command by adding a python mask. This command will list all binds for python scripts.
Tcl Commands¶
+pysource <path/to/file>¶
+The pysource command is analgous to the Tcl source command, except that it loads a Python script into Eggdrop instead of a Tcl script.
Eggdrop Python Commands¶
+The Python module is built to use the existing core Tcl commands integrated into Eggdrop via the eggdrop.tcl module. To call an existing Tcl command from Python, you can either load the entire catalog by running import eggdrop.tcl, or be more specific by from eggdrop.tcl import putserv, putlog, chanlist, etc.
Arguments to the Tcl functions are automatically converted as follows:
+-
+
Noneis converted to an empty Tcl object (the empty string,"")
+ListandTupleis converted to aTcl list
+Dictis converted to aTcl dictionary
+Everything else is converted to a string using the str() method
+
Return values from Tcl functions must be manually converted:
+-
+
""the empty string is automatically converted to None
+everything else is returned as string
+Tcl listas string can be converted to a PythonListusingparse_tcl_list
+Tcl dictionaryas string can be converted to a PythonDictusingparse_tcl_list
+
Additionally, a few extra python commands have been created for use without these conversions:
+bind <arguments>¶
+The python version of the bind command is used to create a bind that triggers a python function. The python bind takes the same arguments as the Tcl binds, but here each argument is passed individually. For example, a bind that would look like bind pub * !foo myproc in Tcl is written as bind("pub", "*", "!foo", myproc). For more information on Eggsrop bind argument syntax please see Bind Types. The eggdrop.tcl.bind command should not be used as it will attempt to call a Tcl proc.
parse_tcl_list <string>¶
+When a python script calls a Tcl command that returns a list via the eggdrop.tcl module, the return value will be a Tcl-formatted list- also simply known as a string. The parse_tcl_list command will convert the Tcl-formatted list into a Python list, which can then freely be used within the Python script.
parse_tcl_dict <string>¶
+When a python script calls a Tcl command that returns a dict via the eggdrop.tcl module, the return value will be a Tcl-formatted dict- also simply known as a string. The parse_tcl_dict command will c
+onvert the Tcl-formatted dict into a Python list, which can then freely be used within the Python script.
Config variables¶
+There are also some variables you can set in your config file:
++++
+- set allow-resync 0
- +
When two bots get disconnected, this setting allows them to create a +resync buffer which saves all changes done to the userfile during +the disconnect. When they reconnect, they will not have to transfer +the complete user file, but, instead, just send the resync buffer.
+
Writing an Eggdrop Python script¶
+This is how to write a python script for Eggdrop.
+You can view examples of Python scripts in the exampleScripts folder included with this module.
+-
+
- bestfriend.py¶
This example script demonstrates how to use the parse_tcl_list() python command to convert a list returned by a Tcl command into a list that is usable by Python.
+
+- greet.py¶
This is a very basic script that demonstrates how a Python script with binds can be run by Eggdrop.
+
+- imdb.py¶
This script shows how to use an existing third-party module to extend a Python script, in this case retrieving information from imdb.com.
+
+- listtls.py¶
This script demonstrates how to use parse-tcl_list() and parse_tcl_dict() to convert a list of dicts provided by Tcl into something that is usuable by Python.
+
+- urltitle.py¶
This script shows how to use an existing third-party module to extend a Python script, in this case using an http parser to collect title information from a provided web page.
+
+
Header section¶
+An Eggdrop python script requires you to import X Y and Z, in this format.
+Code Section¶
+Normal python code works here. To run a command from the Eggdrop Tcl library, use this format.
+Use this format all over.
+Writing a module for use with Eggdrop¶
+This is how you import a module for use with an egg python script.
+Copyright (C) 2000 - 2024 Eggheads Development Team
+