Object Name Imported Built-in and Standard 3rd-party Objects Module (link to code) Class or Function Description Initializing Assignments/Variables names
ARCommandInformation re, tkinter, time, os, getpreferredencoding ar/gen_apps/ar_info.py Class Constructs a primary Class and Function list, along with their descriptions and their module location, for the ar package.
If the HTLML formatting option is set to False (default), the class then attempts to export the source file to Excel. If the HTML option is set to True an HTML formatted document is created and nothing is exported to Excel. (Any othe assignment (e.g. None) will result in no formatting attempt of the text file exported to the designated ar temp directory.)
If relative_path is changed from False to True, the module paths will be changed from absolute to relative.
(htmlformat=False, rootpath=AR_ROOT_PATH, relative_path=False)
ARObjectLocation re, tkinter, time, os, getpreferredencoding ar/gen_apps/ar_info.py Class (htmlformat=False, rootpath=AR_ROOT_PATH, relative_path=False)
ARPackageInformation re, tkinter, time, os, getpreferredencoding ar/gen_apps/ar_info.py Class (htmlformat=False, rootpath=AR_ROOT_PATH, relative_path=False)
ActivityLogs os, tkinter, re, path, time, pickle ar/lg_obj.py Class GUI wrapper for activity/event logs. Execution of the selected log calls the LogPrime class object.
Announce time ar/gen_apps/wo.py Class Exercise Announcement class. Exercise Announcement class.
"repetition_count" is the number of repetitions to be completed. All other instance variables have module-level assigned defaults that can be reassigned in *args. (e.g. osx_volume=4, announcement_format=3)
Optional keword assignments: "announcement_format" indicates how notifications will be announced: - 0 is the system default (audio for Windows, voice for OS X). - 1 audio (Windows requires the win32api module). - 2 visual bells only. - 3 voice (only works on OS X at this time). "osx_volume" adjusts the voice volume. Range is 0 to 7, (OSX system delimiters). "print_passed_args" prints the passed assignments of the current instance if set to True. (Default is False). "remarks_printed_initiation" are the remarks printed/spoken at repetition initiation. "remarks_voice_initiation" overwrites what is spoken at repetition initation. Otherwise defaults to the "remarks_printed_initiation" assignment. "remarks_printed_termination" are the remarks printed/spoken at repetition termination. "remarks_voice_termination" overwrites what is spoken at repetition termination. Otherwise defaults to the "remarks_printed_termination" assignment. "repetition_duration" is the pause time between the initiation of an exercise and its termination. "repetition_pause" is the pause time between repetitions.
(**kwargs)
AnnounceCount(Announce) time, sleep ar/gen_apps/wo.py Class
ArPackageInformationGUI re, tkinter, time, os, getpreferredencoding, rmtree ar/gen_apps/ar_info.py Class
AverageTemperatureExtraction python_version, time, sep, split, clock, copy, exists, remove, move, rmdir ar/gen_apps/nsdmca.py Class This class parses the GHCN annual station reading consolidation files to construct daily, monthly, and annual means from all minimum and maximum station readings located in the file. The mean for each time period is directly sources from the station readings. (i.e. the mean of one time frame is never constructed from the mean of another time frame.) This is to ensure each station reading contributes directly to the mean construction process to avoid any inadvertent skewing of the data.
The files produced are correspondingly saved in day, month, and year sub-directories, which are located within a in a parent directory named nsdmca_extraction_results and divided .
For each year's data, the following files are created from the extracted data: - [specific year]_annual_means.tsv - [specific year]_daily_means.tsv - [specific year]_monthly_means.tsv
If the downloaded file has not been gunzip'ed (i.e. still has the .gz suffix) the class will automatically unzip it. (That said, pre gunzip'ing all files is recommended.)
If the class identifies dates that are out of order within a data file during processing, it will stop the extraction process, reorder the file lines in date order, and recommence processing. This is completed via the "raw_data_reorder" method of this class.
Data from multiple years can be simultaneously process by dividing the source data files into uniquely named directories and executing the AverageTemperatureExtraction class from multiple shells, each process referencing one of the data directories. On that note, while the primary and support files created by this class are all uniquely named according to the NOAA source-file year, calling the AverageTemperatureExtraction class from each shell as a uniquely named object is still recommended.
However the class is to be executed, the directory-file structure anticipated is:
../noaa_datafiles/1700s/1700.csv ../noaa_datafiles/1700s/1701.csv etc. ../noaa_datafiles/1800s/1800.csv ../noaa_datafiles/1800s/1701.csv etc.
This will result in the "nsdmca_extraction_results" directory being located in the same parent directory as the "noaa_datafiles" directory in the example above.
(noaa_temperature_data_directory=None)
Back time, sleep ar/gen_apps/wo.py Class
BoardInterface getpreferredencoding ar/board.py Class Implements the necessary OS interface to achieve the correct open and close calls. get_data returns data from the clipboard/pasteboard. set_data places data into the clipboard/pasteboard.
Chest time, sleep ar/gen_apps/wo.py Class
DEV_comparative_tmax_tmin_counts python_version, time, split, sep ar/gen_apps/ndvao.py Function Data anomalies discovered: daily maximum and daily minimum readings do not always exist in pairs. One is occasionally missing. The frequency of the missing data is currently indeterminate. The impact to mean construction is unknown.
The function logic is to count the number of TMAX and TMIN for each station, for each day to ascertain whether the missing data is frequent enough to have a significant impact on mean temperatures.
(This function is NOT part of any runtime object.)
(noaa_temperature_data_directory=None)
DirectorySyncAndArchiveInitialization re, tkinter, getpreferredencoding, os, copy2, exit ar/gen_apps/dir_sync_file_copy.py Class Simple GUI initialization to call the other classes and functions of the module.
DirectorySynchronization re, tkinter, getpreferredencoding, os, copy2, exit ar/gen_apps/dir_sync_file_copy.py Class Recursively synchronize the file contents of two directories. Specifically designed to synchronize two iTunes directories that may contain partial data sets(songs), it will do so without overwriting (and therefore losing) an identically named file or subdirectory, which might contain only a partial list of songs. It is recursive. File type can be specified by suffix if called from the command line.
Note: This program does NOT update to the most current file. It ensures that two directory trees contain the same file structure while preserving old files.
To GUI directory selection, call: DirectorySynchronization() To use from the command line call: DirectorySynchronization(dir1, dir2, compiledFileSuffix='')
(dir1='', dir2='', filesuffix='')
EquivalencyOperationSelection os ar/tk_encap.py Class A GUI prompt for the desired equivalency operator for the comparison of two numeric fields. Will return '==', '>', <, '!=', or None.
Optional assignments are: field1='Primary Field', field2='Comparison Field'
Use example: eos = EquivalencyOperationSelection(field1, field2).operation_selection()
(field1='Primary Field', field2='Comparison Field')
ExcelOSAError(Exception) sub, popen, Popen, system, setsid, PIPE, split, sleep, exists ar/osx/osa.py Class
FieldSearch re, tkinter, getpreferredencoding, os ar/file_apps/file_srch.py Class Assignments: field_location, search_parameters=None, searchfile=None, savefile=None, action='include', delimiter='\\t', delete_existing_save_file=True
A command line function, its intended use is with delimited text. It breaks each line of a file into fields according to the delimiter variable and then searches a numerically designated field of each row for a specified string. (The first field position is 0.) If the specified search string is found within the specified field, the line is either returned or excluded as determined by the action variable. Lines returning the desired results are written to a separate text file.
search_parameter may also be a list. Lines with matching field information will be written to the same file. If search_parameter is set to None (default), a GUI will open asking for the file that lists the search parameters. (One per line.)
(field_location, search_parameters=None, searchfile=None, savefile=None, action='include', delimiter='\t', delete_existing_save_file=True)
FileAppend os, re, tkinter, getpreferredencoding ar/file_apps/file_proc.py Class A collection of various file appending methods. A direct call results in a GUI, which allows the user to select the desired method.
FileSearchGUI re, tkinter, getpreferredencoding, os ar/file_apps/file_srch.py Class
FileSynchronization re, tkinter, getpreferredencoding, os, copy2, exit, dircmp, time, copytree ar/gen_apps/dir_sync_file_copy.py Class (sync_obj1='', sync_obj2='', checkfilesize=True, remote_dir_path=None, fullecho=True, filesuffix='')
FindAndReplace os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join ar/file_apps/file_proc.py Class (find=None, replace=None, srclocation=None, echo=True)
FirstMatchReturn re, tkinter, getpreferredencoding, os, ttk ar/file_apps/file_srch.py Class (search_parameters=None, recursive_directory_search=True)
HTMLFormElementSearchTool sub, tkinter, I, getpreferredencoding ar/gen_apps/web.py Class Attempts to write to each field of an HTML page by incrementing the form and element field numbers. Results will appear in the online form. The class will also write back via stout any respective field information it can capture.

(endFormRangeNumber=4, endElementRangeNumber=16, printExistingValues=True)
HTMLFormElementSendTool sub, tkinter, I, getpreferredencoding ar/gen_apps/web.py Class
IE win32com.client, getpreferredencoding ar/win/com_ie.py Class The methods of this class are generally called without instantiating the IE class: The methods of this class are generally called without instantiating the IE class:
Use example: IE.url_get()

Initializing the IE class, however, creates an interact able instance of Internet Explorer that is usable by the class' methods.
Tab assignments begin with 1, not 0.
InputGUI os, Tk, Frame, Label, Button, messagebox ar/tk_encap.py Class (ault_input, issue, master_window=None)
Leg time, sleep ar/gen_apps/wo.py Class
LogPrime os, tkinter, re, path, time, pickle, ttk ar/lg_obj.py Class
Login tkinter, exists ar/authenticate.py Class Returns a UID and PW tuple if a previously created authentication file exists. Otherwise the class returns None.
Use example: AUTH_APP = 'example_app_name' accessVariables = Login(AUTH_APP).login_eval() UID = accessVariables[0] PW = accessVariables[1]

(calling_program_name, path=USER_DEFAULTS_DIRECTORY)
ManyToOnePivot tkinter, python_version, getpreferredencoding ar/list_func.py Class Written for situations where a cross-tab query is not the better solution. Written for situations where a cross-tab query is not the better solution.
The data needs to exist in a text file in two columns: many and unique. The many must be grouped.
The separator variable is used to indicate how the input data is separated. The output data columns will also be separated with this variable.
The output_display_separator variable is used to indicate how the pivoted data should display.
Using invoices PO452 and PO341 and respective product codes as an example:
PO341 9875 PO341 6543 PO341 2109 PO452 8635 PO452 2109
will produce:
PO341 9875, 6543,2109 PO452 8635, 2109
(srcfile=None, separator='\t', output_display_separator=', ')
MeanConsolidationFromExtractedData python_version, time, sep, split, clock, copy, exists, remove, move, rmdir ar/gen_apps/nsdmca.py Class (nsdmca_extraction_results=None, dataset_initiation_years=DEFAULT_DATASET_INITIATION_YEARS, sma_intervals=[5, 10, 25, 50, 100])
MultiDBProc walk, sep, exists ar/win/db.py Class An abstracted database class that enables repetitive Access database queries between two interactive databases. Its intent is to save the user from repetitive linking to accomplish an identical task on multiple, identically structured databases.
Though some flexibility exists, the expectation is of a one to many database scenario. (i.e. That one "process" database will contain all the queries and code that will be utilized with multiple identically structured data repository databases, each of which contain data that the "process" database will manipulate. Of note, the opposite can also be accomplished.)
In either case, one of the databases must have internal visual basic code that both auto- executes the requisite queries and quits the active database. The active database must also export or create an empty file named 'db_term.txt' upon database processing completion to provide the MultiDBProc class notification that it may continue.
Pragmatically, the MultiDBProc class is intended to serve as an inheritance class where the "database_product_processing" method would be overloaded to perform any desired tasks immediately after each database is processed. (If no programming tasks are to be completed, on database export products, MultiDBProc can be called as the instantiated class.)

Class logic: 1. Copies the database containing the functions and queries to a temporary location. (All table-linking should be made with this temporary location in mind.) The "process_database_path" assignment is the full path for this database.
2. Copies and renames each target "data" database to the designated temporary location. The "data" databases are selected in turn via the os.walk built-in. The "target_database_dir" assignment is the path of the directory in which all relevant "data" databases are located. (Note: a single database can be targeted if its complete filepath is passed as the "target_database_dir" variable.)
3. Awaits the generation of the "db_term.txt" file in the specified path by the processing database. The full path of this file is assigned via the "db_termination_file" variable. The evaluation of "db_term.txt" will be skipped if the "db_termination_file" is assigned to None.
4. Performs the instruction set described by the overloaded "database_product_processing" method. Its default instruction set is pass.
To assist in identifying the specific "data" database being processed via walk, its full path is assigned to "self.filepath". This can be used during overloading if desired. An example of an implementation option is indicated below.
Simple overload example: (In this example the process database will consistently export a file with the same name: "db_exp.txt", which is exported to the root of c:\)
MultiFileRename re, tkinter, move, getpreferredencoding, time ar/gen_apps/shell_proc.py Class Enter the desired global changes in the prefixstring, suffixstring, and/or deletestring variable fields. The suffixstring changes the file type suffix; a preceding "." is unnecessary but, if added, will still result in a single "." file type demarcation.
None of the class methods are recursive. None of the requested changes will be applied to directories.
The selectDirectory and methodology variables allow for command-line calls. Leaving the selectDirectory as None will result is a call to a GUI (tkinter); otherwise, indicate a full directory path. Leaving the methodology variable as 'insitu' will change the file names in place; otherwise, the renamed files will be copied to a time-stamped directory within the original directory. The original files will be left intact.
(prefixstring='', suffixstring='', deletestring='', methodology='insitu', selectDirectory=None)
MultiFileSearch re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Class (useGUI=True, printTime=True, savefile=None, root=None)
Multiline re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Class (srcfile=None, savefile=None)
PB_Nxt getpreferredencoding, subprocess ar/board.py Class (separator='\n')
PPAPGI tkinter, sys, I, rmtree, sleep ar/ppro_inst.py Class Python Programming And Personal GUI Instantiator .
PageScrape sub, popen, Popen, system, setsid, PIPE ar/osx/osa.py Class Scrapes html coding and visible text from a web page. To keep the text scrape as authentic as possible, the   and & markup characters are converted into their equivalent unicode characters.
know bugs: PageScrape does not seem to perform well when scraping several pages through a proxy.
(url=None, DEFAULT_PROXY=None)
ParallelSearchProcesses(Process) re, os, cpu_count, getpreferredencoding, isdir ar/parallel_process.py Class (parameters, openfile, consolidated_saved_file, processingDirectory='mp_temp_dir')
ParameterError(Exception) e, tkinter, sep ar/gen_apps/sigma.py Class A specific exception to address instruction set failures.
Prime e, tkinter, sep ar/gen_apps/sigma.py Class A made-up homework assignment that plays with prime methods.
Pycurl sub, tkinter, I, getpreferredencoding ar/gen_apps/web.py Class (target_urls=None, target_url_savename=None, max_concurrent_downloads=16, authentication_tuple=None, cookie_mgmt=False,
RC python_version, time, remove, move, split, sep ar/gen_apps/ak_sr.py Class River Comparison. River Comparison.
This class plots comparative run salmon data.
The "rivers" variable is a list of filepaths containing river run data. If "year_range" or "review_months" are respectively assigned None or [], all present data for the respective variable will be returned. "peak_review_percent" is a method that returns run counts for days that meet a specified percentage of the annual max count for each river. Setting it to 0 will bypass that process.
Data for each river must reside in a text file with the data in the following format: - tab delimited - fields can be blank but must line up by date. - the word "date" must appear at position (0,0) (case does not matter.) - the top row must be salmon run years. - the first column must be the month/day combination of the salmon run count. - the month/day combination may or may not have leading zeros but use of leading zeros must be consistent. (i.e all or none.)
Quotes, commas, and spaces do not have to be removed from the text file prior to class execution. They will be stripped by the class object.
Data file format example:

date 1983 1984 1985 1986 1987 1988 6/10 621 6/11 604 695 6/12 761 724 6/13 747 619 350 1620 2221 6/14 642 676 589 1614 3238 6/15 835 843 553 1203 3526 1163 6/16 870 1078 607 1925 4944 1064 6/17 890 795 635 2314 4021 802 6/18 954 814 556 1425 3628 843 6/19 995 1170 589 1698 6588 854 6/20 953 1952 797 1207 5972 1029 6/21 869 2389 640 1160 4729 1229
(river_file_paths=[], year_range=COMPARISION_YEARS, review_months=FISHING_MONTHS, peak_review_percent=80)
RE_FindAndReplace os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists ar/file_apps/file_proc.py Class (uncompiled_regex_locate_str, specific_target_str, specific_replacement_str, ignore_case=True, echo=True)
RandomSample e, tkinter, sep, sample, remove ar/gen_apps/sigma.py Class
RemoveDuplicateElements tkinter, python_version, getpreferredencoding ar/list_func.py Class (source_list=None)
Safari sub, popen, Popen, system, setsid, PIPE, split ar/osx/osa.py Class
SafariAccessError(Exception) sub, popen, Popen, system, setsid, PIPE, split, sleep ar/osx/osa.py Class
SelectFileArchive re, tkinter, getpreferredencoding, os, copy2, exit, dircmp, time, copytree ar/gen_apps/dir_sync_file_copy.py Class
SetLineWidth os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists ar/file_apps/file_proc.py Class (slicelength=78, keepdoublenewline=True, keepwords=True)
SingleFileSearch re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Class (search_parameters=None, srcfile=None, savefile=None, includeFileLocation=False, printTime=True, onlyReturnFirstMatch=False, multiparameter_logic='or')
StationMeanTemperatureExtract(AverageTemperatureExtraction) python_version, time, sep, split, clock, copy, exists, remove, move, rmdir, floor, log10 ar/gen_apps/nsdmca.py Class (stations, dataset_name, noaa_temperature_data_directory=None)
URLCopy sub, tkinter, I, getpreferredencoding, split, Popen, mkdir, clock, time, sleep, getsize ar/gen_apps/web.py Class (target_urls=None, target_url_savename=None, download_directory=USER_DOWNLOADS_DIRECTORY, proxy_portal=None, proxy_protocol='http')
VoiceAnnounceSetSupport(Announce) time, sleep ar/gen_apps/wo.py Class (osx_volume=None, restperiod=DEFAULT_BETWEEN_SET_REST, setcount=DEFAULT_SET_COUNT)
VoiceCountSetSupport(VoiceAnnounceSetSupport) time, sleep ar/gen_apps/wo.py Class
WSA sub, tkinter, I, getpreferredencoding, split, Popen, mkdir, clock, time, sleep, getsize ar/gen_apps/web.py Class (title_description, URL=None, UID_form_element_tuple=None, PW_form_element_tuple=None, direct_method_call=False)
XL sub, popen, Popen, system, setsid, PIPE, split, sleep ar/osx/osa.py Class
_ar_information_html_table_generator re, tkinter, time, os, getpreferredencoding, rmtree ar/gen_apps/ar_info.py Function (sourcefile, targetHTMLfile, relative_path, rootpath, module_path_separator=None)
_on_demand_archive re, tkinter, getpreferredencoding, os, copy2, exit, dircmp, time, copytree, ttk ar/gen_apps/dir_sync_file_copy.py Function
_on_demand_synchronize re, tkinter, getpreferredencoding, os, copy2, exit, dircmp, time, copytree, ttk ar/gen_apps/dir_sync_file_copy.py Function
_parameter_evaluation_construct_save_file_name re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (search_parameters)
active_processes re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE ar/gen_apps/shell_proc.py Function (specificprocess=None)
applescript_codeblock_to_osascript_input_line sub, popen, Popen, system, setsid, PIPE ar/osx/osa.py Function Converts a non-compiled AppleScript into a correctly parsed single line for use with osascript. While the string returned may be suitable for direct import into an osascript execution, it is actually intended to assist in the construction of larger python code blocks. YMMV.
The function loads a single AppleScript that has been saved as a text file and returns it as a single string. (i.e. Paste the code from the "AppleScript Editor.app" code window to a text file.)
Example: tell application "Safari" do JavaScript "window.document.forms[0].elements[0].value='003';" in current tab of first window end tell
becomes: 'tell application "Safari"\\n\\tdo JavaScript "window.document.forms[0].elements[0].value=\'003\';" in current tab of first window\\nend tell'
Do NOT remove or replace any of the \\t or \\n characters.
Background Note: Attempts to write a (simple) osascript string that included javascript repeatedly failed: Specifically, whereas an AppleScript codeblock worked, the constructed osascript input string failed. What was discovered during debugging process was that allowing python to parse the codeblock text into a single line that included all escapes, newlines, etc, produced an implementable osascript string.

(filewithcode=None)
bar_chart python_version ar/gen_apps/mpli.py Function Dev
bell sub, popen, Popen, system, setsid, PIPE, split, sleep, exists ar/osx/osa.py Function
between_exercise_pause time, sleep ar/gen_apps/wo.py Function (pause_if_no_input=True)
clean_list_from_file_lines tkinter, python_version, getpreferredencoding ar/list_func.py Function (srcfile=None)
command_line_synchronization tkinter, sys, I ar/ppro_inst.py Function This synchronizes the command-line module between the ar package and the parent directory of ar. This allows the objects of the command-line module to be called with a cl import rather than requiring the a call of ar.cl.
confirm_action os, Tk, Frame, Label, Button, messagebox ar/tk_encap.py Function (confirmation_message='Continue with action?\n\n')
continue_process os, Tk, Frame, Label, Button, messagebox ar/tk_encap.py Function (process_decision_message='')
copy_file_path getpreferredencoding, subprocess ar/board.py Function
create_list_from_file_lines tkinter, python_version, getpreferredencoding ar/list_func.py Function (srcfile=None)
csv2tsv os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil ar/file_apps/file_proc.py Function (infile=None, outfile=None, echo=True)
date_to_esec time, strptime, mktime ar/dtm_obj.py Function Returns seconds since Epoch. Assignments are the date to be converted to seconds, and the date_format in 'iso' (yyyy-mm-dd), 'us' (mm/dd/yyyy), or 'eur' (dd/mm/yyyy) format.
Hours, minutes, and seconds are not allowable input parameters. If that level of precision is desired, use timestamp_to_sec from this module.
The function utilizes the same pattern inputs as strptime to create a struct_time object for mktime. Converts a date to seconds utilizing mktime and strptime.
(date, date_format='iso')
dcs_activate tkinter, exists ar/win/dcs10.py Function A wrapper around the exe_server_script function from the dde_connect module of the ar package, this function connects to DCS10 and executes a server script.
DCS10 responds to DDE calls to "DCSERIES".
Use example:
This sample function shows an interface between the DCS10 script "example.dct" and python. It relies on the dcs10 script "example.dct" termination notification via a file saved to "C:\temp\dycm_end.txt".
(serverscript, currentexecutionpath=DCS10_INITIALIZATION_PATH)
default_directory_path_selection split, sep ar/path.py Function Written primarily to assist the user setup default directory paths for the ar package in differing environments, this method enables a user to select the drive or path that will become the top level default directory for the invoking object. Returned is the path as a string.
The path_repository_file_name assignment is what the repository file will be named. It is the name of the file wherein the drive or path location is stored, it is not the path itself.
The repository_file_save_location assignment is the full directory path where the file containing the default path will be saved.
If a path requires user selection, a generic remark will state this with an general statement constructed from the path_repository_file_name. The directory_selection_remarks variable allows a message with more informative remarks to be returned.
Use example: (taken from the remote_user_parent_directory assignment from ar.__init__.py)
remote_user_parent_directory = default_path_selection('remote_user', PKG_DEFAULT_PATH_FILES_DIRECTORY, remoteUserDirectoryRemarks)
(path_repository_file_name, repository_file_save_location, directory_selection_remarks=None)
default_directory_path_uninstall split, sep, pickle, rmtree, exit ar/path.py Function
dir_info os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil ar/file_apps/file_proc.py Function (directory=None, echo=True)
distribution e, tkinter, sep, sample, remove, exists, pickle, factorial ar/gen_apps/sigma.py Function (lmd, k)
download_complete sub, tkinter, I, getpreferredencoding, split, Popen, mkdir, clock, time, sleep, getsize, exists ar/gen_apps/web.py Function (file, sleep_increment=2, download_directory=USER_DOWNLOADS_DIRECTORY, echo=True)
ds_multi re, tkinter, getpreferredencoding, os, copy2, exit, dircmp, time, copytree, ttk ar/gen_apps/dir_sync_file_copy.py Function (directory_pairs_list=None)
element_comparison_return tkinter, python_version, getpreferredencoding ar/list_func.py Function (list_1, list_2, greaterthan=True)
element_replace tkinter, python_version, getpreferredencoding ar/list_func.py Function (List, find, replace)
empty_element_strip tkinter, python_version, getpreferredencoding ar/list_func.py Function (processlist)
esec_date time, strptime, mktime, localtime ar/dtm_obj.py Function Utilizes time.localtime to return a date in in 'iso' (yyyy-mm-dd), 'us' (mm/dd/yyyy), or 'eur' (dd/mm/yyyy) format when passed a date in seconds since the epoch. (Such as is returned from: os.path.getmtime()). (seconds_since_epoch, date_format='iso')
esec_time time, strptime, mktime, localtime ar/dtm_obj.py Function Returns the passed epoch seconds in 24hr format. (seconds_since_epoch, time_component_to_return='hms')
espeak exists ar/gen_apps/voice.py Function Invokes Linux espeak software. Invokes Linux espeak software.
To use Gespeaker settings: - The "userGespeakersettings" must be assigned to True - a Gespeaker settings file exists at: '~/.config/gespeaker/settings.conf'
Otherwise, espeak will be invoked using the espeak defaults.
(phrase, enhancement_us_westcoast=True, userGersettings=False)
establish_xl_format copy, win32com.client ar/win/com_xl.py Function Sets the appropriate SaveAs formatting for an Excel workbook by ensuring that "FileFormat" variable is appropriate to the file suffix used in the path name. The workbook variable is, of course, the full path.
Implementation example: saveFilePath = r'c:\some_directory\example.xlsx' current_xl_wb = xl.Workbooks(1) xlWorkbookFormat = establish_xl_format(saveFilePath) current_xl_wb.SaveAs(Filename=saveFilePath, FileFormat=xlWorkbookFormat)
(workbook)
excel_open_example copy, win32com.client, os, sleep ar/win/com_xl.py Function
execute_vb_example copy, win32com.client, os, sleep ar/win/com_xl.py Function Execution a macro from PERSONAL.XLSB
execute_vb_example_wb copy, win32com.client, os, sleep ar/win/com_xl.py Function Execute a macro from a separate workbook.
extract_file_name_no_suffix python_version, time, sep, split, clock, copy, exists, remove, move, rmdir, floor, log10 ar/gen_apps/nsdmca.py Function (inputfile)
extract_file_name_no_suffix re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE ar/gen_apps/shell_proc.py Function (inputfile)
file_extract re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE ar/gen_apps/shell_proc.py Function (src_dir=None, tar_dir=None)
file_info os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil ar/file_apps/file_proc.py Function (filepath=None, echo=True)
file_list_mkdir re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters ar/gen_apps/shell_proc.py Function (file_list=None)
file_list_mv re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters ar/gen_apps/shell_proc.py Function (filelist=None, tar_dir=PYTHON_DEFAULT_DIRECTORY + sep + 'moved_files')
file_list_rm re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters ar/gen_apps/shell_proc.py Function (deletionList=[])
file_split os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil ar/file_apps/file_proc.py Function (linesPerFile=65400, max_file_number=0)
file_time os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil, localtime ar/file_apps/file_proc.py Function (file)
file_walk os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil, localtime ar/file_apps/file_proc.py Function (root_directory=None, redact_system_files=True, topdown=True, onerror=None, followlinks=False)
filename_append split, sep, pickle, rmtree, exit ar/path.py Function (filepath, appending_text)
fsmpe re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (field_location, search_parameters, searchlocation, savefile=None, field_delimiter='\t')
fsms re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (field_location, search_parameters=None, searchfile=None)
fso_swap re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters ar/gen_apps/shell_proc.py Function (primaryObjectTuple, secondaryObject)
get_wd pythoncom, win32com.client, re ar/win/com_word.py Function
get_xl copy, win32com.client, os ar/win/com_xl.py Function Returns a Microsoft Excel Object.
gunzip tkinter, tarfile, os, GzipFile ar/gen_apps/gz.py Function Unzips a compressed file utilizing the tarfile built-in. Files to be unzipped must either be recognized as a tarfile by "tarfile.is_tarfile, or be a compressed text file that has one of the following compression methods: 'gz' - gzip compression 'bz2' - bzip2 compression 'xz' - lzma compression (file=None)
gunzip_dir tkinter, tarfile, os, GzipFile ar/gen_apps/gz.py Function Enables selection of a directory that contains individually compressed files for decompression utilizing the tarfile built-in. Files to be unzipped must either be recognized as a tarfile by "tarfile.is_tarfile, or be a compressed text file that has one of the following compression methods: 'gz' - gzip compression 'bz2' - bzip2 compression 'xz' - lzma compression (directory=None)
gw # GeneratorWrap ar/cl.py Class Returns the next iter. Solution from: http://stackoverflow.com/questions/500578/is-there-an-alternative-way-of-calling-next-on-python-generators. Updated for Python 3.
Use example:
gw # GeneratorWrap
gzip_dir tkinter, tarfile, os ar/gen_apps/gz.py Function Compresses's a directory utilizing the tarfile built-in module. Compresses's a directory utilizing the tarfile built-in module.
Compression options are: 'gz' - gzip compression 'bz2' - bzip2 compression 'xz' - lzma compression
(directory=None, compression='gz')
html_fe_tools sub, tkinter, I, getpreferredencoding, split, Popen, mkdir, clock, time, sleep, getsize, exists ar/gen_apps/web.py Function
input_gui os, Tk, Frame, Label, Button, messagebox ar/tk_encap.py Function (default_input='', issue='User Remarks')
iurlc python_version, time, split, sep ar/gen_apps/ndvao.py Function ICOADS URL construction for subsequent curl acquisition. (year_range=[1763, LAST_YEAR], savefile=None, site_file_format=MARINE_SITE_FILE_FORMAT)
last_line_locate os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil, localtime ar/file_apps/file_proc.py Function (searchparameter, sourcefile, searchFieldNumber=False, delimiter='\t', echo=True)
leading_zeros time, strptime, mktime, localtime ar/dtm_obj.py Function Adds leading zeros to month/day combinations. Month and day integers can be separated by either "/" or "-". Year data is not required but can be included. Year data will have no zero adjustments made.
Anticipated month-day order can be set by referencing one of the optional date formats: 'iso' (yyyy-mm-dd), 'us' (mm/dd/yyyy), or 'eur' (dd/mm/yyyy). Though standard usage is recommended, for flexibility, both "/" and "-" can be used with any date format.

(monthday, date_format='us')
list_compare tkinter, python_version, getpreferredencoding ar/list_func.py Function (saveResultsToFile=True, firstlist=None, secondlist=None)
list_files re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters ar/gen_apps/shell_proc.py Function (directory=None)
list_length_info tkinter, python_version, getpreferredencoding ar/list_func.py Function (List, printInfo=False)
list_to_file_line tkinter, python_version, getpreferredencoding, ascii_letters, punctuation, ceil, ascii_uppercase ar/list_func.py Function (list, separator='\t', endofstring='\n')
ls tkinter, I, sys ar/gen_apps/gui_gen.py Function
macro_execute copy, win32com.client, os ar/win/com_xl.py Function Makes calling an Excel macro from a workbook a little easier by resolving some of the non-intuitive peculiarities involved in calling a macro located within a workbook.
The "workbook" variable is the full path of the workbook containing the macro; macro is the name of the Excel macro, no additional characters or spaces. "visible" determines whether or not Excel is called in a visible state. If visible is set to True, the function will not quit regardless of whether or not quit is set to True. If visible is left as False, Excel quits after macro execution unless quit is set to False.
Note: Other than what may exist for built-in controls, there is no confirmation process to confirm that the macro called has, in fact, fully or successfully executed. This is intentional to allow for the greatest flexibility of implementation.
(workbook, macro, visible=False, quit=True)
moving_average_cumulative e, tkinter, sep, sample, remove, exists, pickle, factorial, mean ar/gen_apps/sigma.py Function (List)
moving_average_simple e, tkinter, sep, sample, remove, exists, pickle, factorial, mean, time, floor ar/gen_apps/sigma.py Function (interval, List)
multi_single_srch re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (listOfStringLocationTuples)
multi_substr_redact tkinter, python_version, getpreferredencoding ar/list_func.py Function (textstring, list_of_substrings_to_redact)
multifile_prefix_strip re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters ar/gen_apps/shell_proc.py Function (prefixlist, directory=None, overwritefiles=False, insitu_rename=True)
multilist_element_recombine tkinter, python_version, getpreferredencoding ar/list_func.py Function (listoflists)
multiprocessor_search_engine re, os, cpu_count, getpreferredencoding ar/parallel_process.py Function (parameter, target_search_file, temp_save_directory)
noaa_data_validation_file_date python_version, time, split, sep ar/gen_apps/ndvao.py Function Validates that each year file contains only that year. Results saved to noaa_validation_wrong_date_in_dataset.txt in the directory specified by noaa_temperature_data_directory. It relies on the NOAA file naming convention that the name of the file is the year.
(This function is NOT part of any runtime object. It was constructed due to a question raised by a data anomaly; subsequent validations have demonstrated that the annual files indeed only contain the year specified by the name of the file.)
(noaa_temperature_data_directory=None)
non_numeric_strip tkinter, python_version, getpreferredencoding, ascii_letters, punctuation ar/list_func.py Function (string)
now time, strptime, mktime, localtime ar/dtm_obj.py Function Returns the current system time in 24hr format to the second. (seconds_to_adjust=0, time_component_to_return='hms')
o2m_field_cascade os, re, tkinter, getpreferredencoding, exit, askopenfilename, sleep, asksaveasfilename, clock, time, join, ttk, sep, exists, shutil, localtime ar/file_apps/file_proc.py Function (filepath=None, header=True, delimiter='\t')
open_dir_path_str os, Tk, Frame, Label, Button, messagebox, Toplevel, Entry, askdirectory ar/tk_encap.py Function (defaultDirectory=PYTHON_DEFAULT_DIRECTORY)
open_dir_path_str_file_select os, Tk, Frame, Label, Button, messagebox, Toplevel, Entry, askdirectory, askopenfilename ar/tk_encap.py Function (defaultDirectory=PYTHON_DEFAULT_DIRECTORY, defaultFileName='Select any file within target directory')
open_file re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters ar/gen_apps/shell_proc.py Function (fileToOpen)
open_file_path_str os, Tk, Frame, Label, Button, messagebox, Toplevel, Entry, askdirectory, askopenfilename ar/tk_encap.py Function (defaultDirectory=PYTHON_DEFAULT_DIRECTORY, defaultFileName='')
osascript sub, popen, Popen, system, setsid, PIPE ar/osx/osa.py Function Implements a non-compiled AppleScript via an osascript call to the system through subprocess.Popen. "input" is the complete well-formed AppleScript codeblock.
If the osascript should return passed data (generally but not exclusively from a "get" or "set" request), assign the return_data_response variable to True. Data responses will be in byte code.
For assistance with the construction/conversion of "input" consider the following tools, which are found in this module: - applescript_codeblock_to_osascript_input_line - osascript_input_line_parse
(input, return_data_response=False)
osascript_input_line_parse sub, popen, Popen, system, setsid, PIPE ar/osx/osa.py Function The primary osa.py osascript statement preparation function, osascript_input_line_parse assists in constructing "well formed" osascript input strings by handling the AppleScript tell and end tell clauses for any specified application. Its use is optional.
The applescript_phrase variable is the string statement that instructs what you want the application to do.
In the following AppleScript example using Safari, "get URL of current tab of first window" is the desired applescript_phrase assignment:
tell application "Safari" get URL of current tab of first window end tell
Use example: >>> phrase = osascript_input_line_parse('Safari', 'get URL of current tab of first window') >>> >>> print(phrase) >>> 'tell application "Safari"\n\tget URL of current tab of first window\nend tell'
(application, applescript_phrase)
page_scrape sub, tkinter, I, getpreferredencoding, split, Popen, mkdir, clock, time, sleep, getsize, exists, punctuation ar/gen_apps/web.py Function (url=None)
personal_workbook_path copy, win32com.client, os ar/win/com_xl.py Function Personal workbook (macro) locator for Windows 7. (printWBlocation=True)
play_sound sub, popen, Popen, system, setsid, PIPE, split, sleep, exists ar/osx/osa.py Function (sound_file_path, terminateQuickTime=False, terminationDelay=0)
prepend_0 tkinter, python_version, getpreferredencoding, ascii_letters, punctuation ar/list_func.py Function (standard_str_len, numeric_str_list=None)
psms re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (multi_file_search=False, search_parameters=None, searchlocation=None, outfile_dir=None)
pyc_delete re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters, rmtree ar/gen_apps/shell_proc.py Function (bootroot=AR_ROOT_PATH)
re_file_search re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (regex, srcfile=None, savefile=None, exclude='no', echo=True)
re_group_str_rtn re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (regex, savefile=None, srcfile=None, echo=True)
re_multi_file_search re, tkinter, getpreferredencoding, os, ttk, time ar/file_apps/file_srch.py Function (regex, rootdirectory=None, exclude='no')
recursive_directory_construction split, sep, pickle, rmtree, exit, exists ar/path.py Function (pathORpathlist, echo=True)
revise_list_to_list_of_fixedlength_sublists tkinter, python_version, getpreferredencoding, ascii_letters, punctuation, ceil ar/list_func.py Function (original_list, sublist_element_length)
rm_dup_line re, tkinter, getpreferredencoding, os, ttk, time, copy2 ar/file_apps/file_srch.py Function (reviewfile=None)
rm_pkg_defaults tkinter, sys, I, rmtree ar/ppro_inst.py Function Removes the set path defaults for the ar package.
rm_shrtct tkinter, sys, I, rmtree ar/ppro_inst.py Function
rmtree_gui re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE, ascii_letters, rmtree ar/gen_apps/shell_proc.py Function (path=None)
save_file_path_str os, Tk, Frame, Label, Button, messagebox, Toplevel, Entry, askdirectory, askopenfilename, asksaveasfilename ar/tk_encap.py Function (defaultDirectory=PYTHON_DEFAULT_DIRECTORY, defaultFileName='')
scramble ascii_letters, digits, punctuation, whitespace ar/str_crypt.py Function Reorders string characters according to the internal algorithm of the function. It is bidirectional so a previously scrambled string will be properly unscrambled.
Use example: processed_string = scramble(string_to_scramble)
(string_to_)
sp_insrt tkinter, python_version, getpreferredencoding, ascii_letters, punctuation, ceil, ascii_uppercase ar/list_func.py Function (srcfile=None)
spec_fld_ext re, tkinter, getpreferredencoding, os, ttk, time, copy2 ar/file_apps/file_srch.py Function (field_locations=0, sourcefile=None, delimiter='\t')
station_data_tmax_tmin_line_extract python_version, time, split, sep ar/gen_apps/ndvao.py Function This object was developed as part of the second tier analysis for unique station data. It constructs a temperature dataset from the NOAA source data universe that consists only of temperature readings (TMAX and TMIN).
Analysis of localized temperature (unique station) data relies upon the files produced by this object.
Because the "station_data_tmax_tmin_line_extract" function was developed after the AverageTemperatureExtraction
(noaa_temperature_data_directory=None)
str_brk_len tkinter, python_version, getpreferredencoding, ascii_letters, punctuation, ceil, ascii_uppercase ar/list_func.py Function (slicelength, textstring, onwhitespace=True)
sufficient_sample_size e, tkinter, sep, sample, remove, exists, pickle, factorial, mean, time, floor ar/gen_apps/sigma.py Function (population=0, error_margin=5, z_score=95, StdDev=.5)
sys_prcss re, tkinter, move, getpreferredencoding, time, os, copy, ttk, Popen, PIPE ar/gen_apps/shell_proc.py Function
temperature e, tkinter, sep, sample, remove, exists, pickle, factorial, mean, time, floor ar/gen_apps/sigma.py Function
time_diff time, strptime, mktime, localtime ar/dtm_obj.py Function Returns a time difference as list. Return order is difference in: seconds, minutes, hours, days, months, and years. (time_in_seconds_1, time_in_seconds_2)
timestamp_to_esec time, strptime, mktime, localtime ar/dtm_obj.py Function Returns seconds since Epoch from a full time-stamp. Assignments are date, the formatting of which is indicated by date_format: 'iso' (yyyy-mm-dd), 'us' (mm/dd/yyyy), or 'eur' (dd/mm/yyyy) format, and time which must be in hh:mm:ss. Hours (hh) refer to a 24 hour clock.
The function utilizes the same pattern inputs as strptime to create a struct_time object for mktime. Converts a date to seconds utilizing mktime and strptime.
(date, time, date_format='iso')
today time, strptime, mktime, localtime ar/dtm_obj.py Function Returns today's date (plus or minus a numeric number of days) in the specified "iso", "us", or "eur" format. Otherwise, the function returns a tuple of dates in the following formats: 'iso' (yyyy-mm-dd), 'us' (mm/dd/yyyy), or 'eur' (dd/mm/yyyy).
The returned date can be adjusted relative to the current date by setting a positive or negative integer.
If the optional format assignment is set to iso, us, or eur, a single date is returned in the format specified.
(days_to_adjust=0, date_format='')
uncorrupted_file_copy2 re, tkinter, getpreferredencoding, os, copy2, exit, dircmp, time, copytree, ttk ar/gen_apps/dir_sync_file_copy.py Function (directory='', targetDirectory=PROCESSES_DIRECTORY)
visual_announce tkinter, sys, I, rmtree ar/ppro_inst.py Function
volume ar/gen_apps/wo.py Function (*args)
volume sub, popen, Popen, system, setsid, PIPE, split, sleep, exists ar/osx/osa.py Function (level)
volume_normalize ar/gen_apps/wo.py Function (*args)
worklog tkinter, sys, I, rmtree ar/ppro_inst.py Function
xl_create_example copy, win32com.client, os, sleep ar/win/com_xl.py Function
xl_quit copy, win32com.client, os ar/win/com_xl.py Function Quits any currently running instance of Excel.
xl_simple_format copy, win32com.client, os ar/win/com_xl.py Function A simple formatting function that invokes Microsoft Excel to open a text file, set column spacing, and bold the first row if it contains headers. Variables are activated by setting them to anything other than than their default assignments.
Note: Excel columns start at 1, not 0. If a sort is desired, sortcolumn should be >= 1.
(infile, outfile=None, header=False, sortcolumn=None, xlquit=False, workbookvisible=True, endColumn=256)
xl_to_txt_conversion copy, win32com.client, os ar/win/com_xl.py Function Opens an Excel file and saves it as tab delimited text. source_xl_document and xl_txt_conversion_export are string path variables. (source_xl_document, xl_txt_conversion_export=None)
xl_to_txt_walk copy, win32com.client, os, sleep ar/win/com_xl.py Function Recursively walks through directory src_dir and copies all files to directory tar_dir. If the file name already exists, a "_[new version number]" is appended to the end.
Since use of a specific text file conversion repository directory is necessary, that path is returned for use by the calling object unless the entire process is cancelled by the user; in which case None is returned. IE. text_file_repository_path = xl_to_txt_walk() .
(src_dir=None)
xlsx_conversion copy, win32com.client, os, sleep ar/win/com_xl.py Function Converts a .txt file or an .xls workbook to a .xlsx workbook. (infile, outfile=None)
xlsx_conversion_walk copy, win32com.client, os, sleep ar/win/com_xl.py Function Iterates through the file list returned by os.listdir for the selected directory and converts all .txt and .xls files to .xlsx. Files are converted and saved to the same directory as the parent files. The original files are not removed. (src_dir=None)
yield_list tkinter, python_version, getpreferredencoding, ascii_letters, punctuation, ceil, ascii_uppercase ar/list_func.py Function (List)
Last code upload to website: 2016-08-10
Current AR package version: 0.4.90
Module most recently updated: ppro_inst.py