pax_global_header00006660000000000000000000000064146055652500014522gustar00rootroot0000000000000052 comment=722af0bea21936879b200c5459cc4b15b929459e python-progress-bar-1.2/000077500000000000000000000000001460556525000153115ustar00rootroot00000000000000python-progress-bar-1.2/.github/000077500000000000000000000000001460556525000166515ustar00rootroot00000000000000python-progress-bar-1.2/.github/FUNDING.yml000066400000000000000000000000211460556525000204570ustar00rootroot00000000000000github: [oldabl] python-progress-bar-1.2/.gitignore000066400000000000000000000034071460556525000173050ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ pip-wheel-metadata/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json # Pyre type checker .pyre/ python-progress-bar-1.2/ProgressBar.py000066400000000000000000000106341460556525000201200ustar00rootroot00000000000000import time, sys, os, math # Class: ProgressBar # Role: print a progress bar with next to no # line of code required by user class ProgressBar: # Role : assign arguments to internal values def __init__(self, pretext=r"", # Text to print before the bar progresschar=r"█", # Character of done part of the bar remainingbarchar=r" ", # Character to fill the remaining bar with loadingchars=r"█▓▒░▒▓", # Last character of bar moving as bar loads (moves even if no progress) startendchar=r"||", # The two characters going around the bar displaypercentage=True, # Show percentage as well or not displaycount=False, # Show count as well or not rightjustified=True, # Print the bar on the right hand side of the console consolewidthrate=3 # Print the bar on 1/3 of the width of console ): self.pretext = str(pretext) self.progresschar = str(progresschar) self.remainingbarchar = str(remainingbarchar) self.loadingchars = loadingchars self.startendchar = str(startendchar) self.displaypercentage = displaypercentage self.displaycount = displaycount self.rightjustified = rightjustified self.consolewidthrate = consolewidthrate # Private self.loadingcharsindex = 0 self.firstprint = True # Role : prints the progress bar as an independent thread # Arguments: # - number: progress value (type multiprocessing.Value of int) # - max: value to reach (int) # - updateperiod: refresh period of progress bar in seconds def inThread(self, number, max, updateperiod=0.1): while(number.value < max): self.print(number.value,max) time.sleep(float(updateperiod)) self.print(max,max) # Role : prints the progress bar inline # Arguments: # - number: progress value (int) # - max: maximum value (int) def print(self,number,max): actuallyjustifyright = True consolewidth = os.get_terminal_size().columns prebarstring = barstring = "" # No carriage return on first print if not self.firstprint: prebarstring += "\r" self.firstprint = False ### Pre progress bar if self.pretext: compatiblepretext = self.pretext limitsizepretext = math.floor( (1-1/self.consolewidthrate)*consolewidth ) if self.displaycount: limitsizepretext = limitsizepretext - 4 - len(str(max))*2 if self.displaypercentage: limitsizepretext = limitsizepretext - 5 limitsizepretext = limitsizepretext - len(self.startendchar) - 2 limitsizepretext = limitsizepretext - 1 if len(compatiblepretext) >= limitsizepretext: # If pretext is too long compatiblepretext = compatiblepretext[:limitsizepretext]+"..." actuallyjustifyright = False prebarstring += compatiblepretext + " " ### Progress bar # Start char if self.startendchar: barstring += self.startendchar[0] # Current state of affairs barwidth=int(os.get_terminal_size().columns/self.consolewidthrate) # Calculated from terminal size sofarbar = int( (number/max)*barwidth ) remainingbar = barwidth - sofarbar # Add progress chars barstring += sofarbar*self.progresschar # If loading chars, print loading chars and go to next one (unless 100%) if self.loadingchars != "" and number != max: barstring += self.loadingchars[self.loadingcharsindex] self.loadingcharsindex = (self.loadingcharsindex+1) % len(self.loadingchars) remainingbar -= 1 # Add remaining gap barstring += remainingbar*self.remainingbarchar # End char if self.startendchar: if len(self.startendchar) >= 2: barstring += self.startendchar[1] else: barstring += self.startendchar[0] ### Post progress bar if self.displaypercentage: per = " %d%%" % int(number*100/max) barstring += " "*(5 - len(per)) + per if self.displaycount: count = " (%d/%d)" % (number,max) barstring += " "*(len(str(max))-len(str(number))) + count # Print the bar out if self.rightjustified and actuallyjustifyright: fillthevoid = " "*(consolewidth-len(prebarstring)-len(barstring)-1) sys.stdout.write(prebarstring + fillthevoid + barstring + " ") sys.stdout.flush() else: sys.stdout.write(prebarstring + barstring) sys.stdout.flush() # Add new line if bar is finished if number == max: print() python-progress-bar-1.2/README.md000066400000000000000000000040371460556525000165740ustar00rootroot00000000000000# Python Progress Bar Prints an all customisable **easy-to-use** progress bar. It can be the thread target or a normal function call. ## Import in your code ```python from *folderclone*.ProgressBar import ProgressBar ``` Now use as class ProgressBar. /!\ folderclone should not contain character "-". Make sure not to clone in default git clone dir for this repo. ## Use ### As a simple function call ```python max = 30 progressbar = ProgressBar() for n in range(0,max): progressbar.print(n,max-1) time.sleep(1) # To see progress ``` ### As a separate thread target (adds 7 lines to your code) ```python max = 30 progressbar = ProgressBar() number = multiprocessing.Value("i", 0) pr = multiprocessing.Process(target=progressbar.inThread, args=(number,max-1)) pr.start() # YOUR CODE GOES BELOW # It needs to increment the ProgressBar number for n in range(0,max) number.value = n time.sleep(1) # YOUR CODE GOES ABOVE pr.join() # or pr.kill() ``` ## Go further: customise your bar ### Style parameters You can give the following optional arguments to the ProgressBar constructor: - pretext: Text to print before the bar (default "") - progresschar: Character to show progress (default '█') - remainingbarchar: Character to fill the remaining bar with (default ' ') - loadingchars: Last character of bar moving as bar loads (moves even if no progress) (default "█▓▒░▒▓") - startendchar: The two characters going around the bar (default "||") - displaypercentage: Show percentage as well or not (default False) - displaycount: Show count as well or not (default False) - rightjustified: Print the bar on the right hand side of the console (default True) - consolewidthrate: Choose the section the bar occupies on the console (default 3 => 1/3 of the console) ### Thread parameters If you use the thread version, you can customise the refresh time of your progress bar. To do this, give an extra argument (type float) representing the refreshing period of the bar. ```python multiprocessing.Process(target=progressbar.inThread, args=(number,max,0.2)) ``` python-progress-bar-1.2/__init__.py000066400000000000000000000000001460556525000174100ustar00rootroot00000000000000