Script, Library, or Executable? You can have it all!

One potential way to grow a CLI script into a package supporting CLI, GUI, Library, and Executable.

Transcript

1. Script, Library, or Executable? You can have it ALL! http://bit.ly/pyconde_pywc_refs 1
2. Luke Lee @durden20 Python GUI and CLI applications for Oil and Gas http://bit.ly/pyconde_pywc_refs 2
3. CLI Library GUI Executable http://bit.ly/pyconde_pywc_refs 3
4. 1. CLI import sys lines = 0 words = 0 with open(sys.argv[1], 'rb') as file_obj: for line in file_obj: lines += 1 words += len(line.split()) print(f'{lines} {words}') http://bit.ly/pyconde_pywc_refs 4
5. Separation of concerns http://bit.ly/pyconde_pywc_refs 5
6. Separation of concerns def cli(): """ Parse sys.argv and return dictionary of arguments/configuration """ pass def get_file_info(file_): """ Return lines/words in file """ pass if __name__ == '__main__': file_ = cli() print(get_file_info(file_)) http://bit.ly/pyconde_pywc_refs 6
7. file_info = collections.namedtuple('file_info', 'lines words') def get_file_info(file_): lines = 0 words = 0 with open(file_, 'rb') as file_obj: for line in file_obj: lines += 1 words += len(line.split()) return file_info(lines, words) http://bit.ly/pyconde_pywc_refs 7
8. def cli(): parser = argparse.ArgumentParser(prog='pywc') parser.add_argument('arg', action='store', help='File or directory to count lines/words for') parser.add_argument('-w', dest='count_words', action='store_true', default=False, help='Show number of words in file(s)') parser.add_argument('-l', dest='count_lines', action='store_true', default=False, help='Show number of lines in file(s)') # Using vars() to turn namespace object returned by parse_args() into a # dict. args = vars(parser.parse_args()) # Mimic wc command by printing both of these if there are no other # arguments if not args['count_words'] and not args['count_lines']: args['count_words'] = True args['count_lines'] = True return args http://bit.ly/pyconde_pywc_refs 8
9. 2. Library - setup.py - pywc/ - api.py - __init__.py - __main__.py http://bit.ly/pyconde_pywc_refs 9
10. setup.py from setuptools import setup, find_packages setup( name='pywc', version='1.0.0', packages=find_packages(), ) http://bit.ly/pyconde_pywc_refs 10
11. __main__.py http://bit.ly/pyconde_pywc_refs 11
12. from .api import get_file_info def cli(): """ Parse sys.argv and return dictionary of arguments """ pass def main(): args = cli() file_info = get_file_info(args['file']) if args['count_lines']: print(f' {file_info.lines}', end='') if args['count_words']: print(f' {file_info.words}', end='') print(f' {args['file']}') if __name__ == '__main__': main() http://bit.ly/pyconde_pywc_refs 12
13. CLI ? http://bit.ly/pyconde_pywc_refs 13
14. entry_points http://bit.ly/pyconde_pywc_refs 14
15. from setuptools import setup setup( name='pywc', version='1.0.0', packages=find_packages(), entry_points={ 'console_scripts': [ 'pywc = pywc.__main__:cli' ] }, ) http://bit.ly/pyconde_pywc_refs 15
16. python -m http://bit.ly/pyconde_pywc_refs 16
17. python -m http.server json.tool pdb timeit cProfile unittest doctests tarfile zipapp zipfile webbrowser base64 calendar sysconfig http://bit.ly/pyconde_pywc_refs 17
18. python -m pywc -h pywc -h http://bit.ly/pyconde_pywc_refs 18
19. Gooey http://bit.ly/pyconde_pywc_refs 19
20. 3. GUI from gooey import Gooey @Gooey def cli(): parser = argparse.ArgumentParser( prog='pywc', description='Count lines/words in files or directory') parser.add_argument( 'arg', action='store', help='File or directory to count lines/words for') ... http://bit.ly/pyconde_pywc_refs 20
22. GUI as option (--gui) def cli(allow_gui_option=True): """ Add --gui option to call gui() """ pass def gui(): # Gooey doesn't like functools.partial def cli_only(): return cli(allow_gui_option=False) return Gooey(cli_only, program_name='pywc', show_success_modal=False) http://bit.ly/pyconde_pywc_refs 22
23. from setuptools import setup setup( entry_points={ 'console_scripts': [ 'pywc = pywc.__main__:cli' ] 'gui_scripts': [ 'pywcg = pywc.__main__:gui' ] }, ) http://bit.ly/pyconde_pywc_refs 23
24. python -m pywc --gui pywcg http://bit.ly/pyconde_pywc_refs 24
25. PyInstaller http://bit.ly/pyconde_pywc_refs 25
26. ? http://bit.ly/pyconde_pywc_refs 26
27. 4. Executable - setup.py - cli.py - gui.py - pywc/ - api.py - __init__.py - __main__.py http://bit.ly/pyconde_pywc_refs 27
28. cli.py from pywc.__main__ import cli if __name__ == '__main__': cli() http://bit.ly/pyconde_pywc_refs 28
29. gui.py from pywc.__main__ import gui if __name__ == '__main__': gui() http://bit.ly/pyconde_pywc_refs 29
30. pip install pyinstaller http://bit.ly/pyconde_pywc_refs 30
31. pyinstaller cli.py --name pywc http://bit.ly/pyconde_pywc_refs 31
32. pyinstaller gui.py --name pywcg -w http://bit.ly/pyconde_pywc_refs 32
33. ❗ Takeaways ❗ http://bit.ly/pyconde_pywc_refs 33
34. Separation of concerns http://bit.ly/pyconde_pywc_refs 34
35. entry_points http://bit.ly/pyconde_pywc_refs 35
36. __main__.py http://bit.ly/pyconde_pywc_refs 36
37. Gooey http://bit.ly/pyconde_pywc_refs 37
38. PyInstaller http://bit.ly/pyconde_pywc_refs 38
39. Ready. Set. Launch. ! " http://bit.ly/pyconde_pywc_refs 39
40. pywc pywc --gui pywcg python -m pywc python -m pywc --gui pywc.exe pywcg.exe python cli.py python cli.py --gui python gui.py http://bit.ly/pyconde_pywc_refs 40
41. and these ... ! pywcg --gui python gui.py --gui pywcg.exe --gui http://bit.ly/pyconde_pywc_refs 41
42. Luke Lee @durden20 http://bit.ly/pyconde_pywc_refs 42