ParTools 2.0.3

This package contains a bunch of Python tools developed for Support, Test and Automation IT Engineers

ParTools

This package contains a bunch of Python tools I have developed and used as an IT Test / Support / Automation Engineer.
You can mainly use them for:

• Performing multi threaded SQL queries on an Oracle DB (sql)
• Performing multi threaded SQL queries on a given perimeter on an Oracle DB (rl)
• Comparing and sorting potentially big files (dq)
• Reading and searching potentially big files (tools.bf)
• Parsing potentially big XML files (tools.xml)
• Searching and removing duplicates (tools.dup)
• Filtering potentially big files with flexible conditions (tools.filter)
• Splitting potentially big files (tools.split)
• Extracting doc string from Python code (tools.extract_doc)
• Sending mails with gmail, outlook or without authentication (mail)
• Simple logging or logging in loops (log and step_log), manipulating files and strings, running shell commands, generating threaded message boxes and many others (utils)

Quickstart

pip install partools

Create a python file containing:

import partools.utils as u

u.init_log('TEST', True)
u.log('Hello World')

And run it. You should then see something like this in the console:

...
Checkout the README.md on GitHub: https://github.com/paularnaud2/ParTools
Get started here c:\Git\Test\venv\lib\site-packages\partools\quickstart
Set up your conf here: c:\Git\Test\venv\lib\site-packages\partools\conf.py
Happy scripting!
...
07:51:26 - Hello World

This gives you the links to the quickstart folder where you'll find examples of use and descriptions of the different available packages and functions. You'll also find here the link to the conf.py file (see below).

If you want to use the cx_Oracle dependant packages (sql and rl), you'll need an Oracle instant client whose directory you can set in the conf.py file.

The conf.py file

The partools/conf.py file contains the main user settings for the partools package such as the path to the Oracle instant client (ORACLE_CLIENT). If needed, you can create a PTconf.py file at the root whose attributes will overwrite default (found in partools/conf.py). Similarly, you can also create a PTconf_perso.py file that will take over PTconf.py. This can be useful if you work on a shared repository but still want/need to have your own local configurations.

The global variable files gl.py and main functions inputs

Each package has a gl.py file which sets its global variables and constants. Each of these variables can be passed to the main package function (e.g. rl.reqlist for the rl package) and if so, overwrites the value defined in the gl.py file. In that respect, constants defined in the gl.py file can be seen as default input values.

The utils package

The partools package includes a utils package which provides generic functions used by the other packages. As you may want to use some of them for your own code, I recommend you to check out the list of those functions in partools/utils/__init__.py. Here are a few examples:

• save_list: saves a list into a text file
• load_txt: loads a text file into a string or a list
• list_files: returns the list of the files in a folder
• like: behaves as the LIKE of Oracle SQL (you can match strings with wildcard character '*'). It returns a re.match object giving you access to the matched wildcards.
  Example: m = like('Hello World', 'He\*o w\*d'), m.group(1) => 'll'
• big_number: converts a potentially big number into a lisible string. For example big_number(10000000) returns '10 000 000'.
• get_duration_string: outputs a string representing the time elapsed since the input start_time. For example get_duration_string(0, end_time=200) returns '3 minutes and 20 seconds'.
• run_cmd: runs a Windows shell command (sTools)
• run_sqlplus: connects to sqlplus as sysdba and runs a sql script (sTools)
• msg_box: opens a threaded message box containing the 'msg' input string. This can be used as a end-process notification (sTools)

Logging with the utils package

If you want the log function to actually fill a log file, you have to run init_log() before using it, otherwise it will just print out the log info in the console.
You can specify a log_format for the log timestamp which by default is '%H:%M:%S -' (conf.LOG_FORMAT setting). Here is what a default log line looks like:

19:45:04 - This line has been generated by the partools.utils.log function

The step_log function allows you to log some information only when the input counter is a multiple of the input step. Thus, step_log is to be used in loops to track the progress of long processes such as reading or writing millions of lines in a file. The what input expects a description of what is being counted. It's default value is 'lines written'.
In order to correctly measure the elapsed time for the first log line, the step_log function has to be initialised by running init_sl_time().
So for example, if you input step=500 and don't input any what value, you should get something like this:

19:45:04 - 500 lines written in 3 ms. 500 lines written in total.
19:45:04 - 500 lines written in 2 ms. 1 000 lines written in total.
19:45:04 - 500 lines written in 2 ms. 1 500 lines written in total.

Checkout the utils_log.py file in partools/quickstart for a simple example of use.

The PT folder

When first used, the utils package gets initialised by creating a PT directory (which you can set in conf.py). It is intended to contain the log files and the temporary files generated by the different ParTools's scripts. It also has in and out directories used by the test package (and of course that you can also use for your own scripts using ParTools).

The sql package

The sql package provides you with three main functions:

• download: executes multithreaded SELECT or COUNT queries (see partools/quickstart/sql_download.py)
• upload: executes mass insert queries (see partools/quickstart/sql_upload.py)
• execute: executes PL/SQL procedures or SQL scripts (see partools/quickstart/sql_execute.py)

The download function has three main cases of use:

• Writing the result of a simple SELECT/COUNT query in a csv file
• Processing a list of SELECT/COUNT queries in parallel
• Processing a range query ie. a variabilized query which is executed in parallel for a specified range of KEYs/IDs

Each of these cases is detailed in partools/quickstart/sql_download.py

The rl package

The rl package has two main functions:

• reqlist: executes a multithreaded SELECT query on a perimeter given by a csv file. The SQL output can be joint to the input file (see partools/quickstart/reqlist.py)
• left_join_files: performs a joint between two csv files. This function is used by reqlist to joint the SQL result to the input file.

Sending emails

ParTools is provided with a mail package allowing you to easily send HTML emails with Python. Three functions are available corresponding to different infrastructure/environment usages:

• gmail: for personal computer/network use
• no_auth: for business computer/network use (if an internal no authentication smtp server is available)
• outlook: for business computer/network use (uses your Outlook application)

In order for the mail package to be working, you have to initialise a mail folder by running the 'init_mail' function. This will create a folder in the MAIL_DIR defined in 'conf.py' ('mails/' by default).

If you want to use the gmail or no_auth functions, you have to set a confidential.txt file. This file must be saved at the CFI_PATH defined in the partools/conf.py file (root by default) using the example provided in the initialised folder.

The initialised folder contains the mail folders corresponding to the mail_name passed in the mail function. As you'll notice, it initially contains a 'test' folder, allowing you to quickly test the function and to provide you with an example of what a 'mail_name' folder is expected to contain. USER_GMAIL and PWD_GMAIL are only to be set if you use the gmail function.

So you'll see two files in the mails/test folder:

• template.html: the HTML template for the body of your mail. It can contain variables delimited by @@ (in the example @@NAME@@ and @@DATE@@) which are replaced using the var_dict passed in input.
• recipients.txt: the list of recipients here containing three fictitious recipients. For your test, it is advised to just let one line with your address.

You can also directly input a recipients list and a HTMLbody. In that case, setting the template.html and recipients.html is not needed. If you input a HTMLbody and a var_dict, your HTMLbody input will be seen as a template whose variables will be replaced using the var_dict.

For the no_auth function, you'll need to set the host in the conf file (HOST_NO_AUTH).

Recover functionalities

sql.download, rl.reqlist and sql.execute have a recovery functionality. This means that if the process is unexpectedly stopped (e.g. because of network issues), then when relaunched, the script automatically restarts from where it stopped. When you run long processes (e.g. extracting millions of lines from a database), this can save you a significant amount of time if something goes wrong (especially when close to the end!).
The reliability of these recovery mechanisms is ensured by automated tests using the multiprocessing library to simulate the unexpected process interruption.

Happy scripting!