Burgerlib Python
Loading...
Searching...
No Matches
Functions | Variables
burger.cleanutils Namespace Reference

Package that contains clean helper functions. More...

Functions

def clean_xcode (path, recursive=False)
 Scan for XCode project folders and perform a clean. More...
 
def clean_codeblocks (path, recursive=False)
 Scan for Codeblocks project files and perform a clean. More...
 
def clean_setup_py (path, recursive=False)
 Scan for setup.py files and perform a clean. More...
 

Variables

 _CODEBLOCKS_MATCH
 Match *.cbp.
 

Detailed Description

Package that contains clean helper functions.

Function Documentation

◆ clean_codeblocks()

def burger.cleanutils.clean_codeblocks (   path,
  recursive = False 
)

Scan for Codeblocks project files and perform a clean.

Scan the current folder and for every codeblocks project file, remove all .depend and .layout files from the folder

Parameters
pathDirectory to begin scanning
recursiveBoolean if recursive clean is desired
See also
clean_xcode

◆ clean_setup_py()

def burger.cleanutils.clean_setup_py (   path,
  recursive = False 
)

Scan for setup.py files and perform a clean.

Scan the current folder and if the file setup.py was found, remove the folders dist, build, _build, .tox, .pytestcache and *.egg-info

Parameters
pathDirectory to begin scanning
recursiveBoolean if recursive clean is desired
See also
clean_xcode
clean_codeblocks

◆ clean_xcode()

def burger.cleanutils.clean_xcode (   path,
  recursive = False 
)

Scan for XCode project folders and perform a clean.

Scan the current folder and for every folder that is an XCode project, remove all user files from the folder

Parameters
pathDirectory to begin scanning
recursiveBoolean if recursive clean is desired
See also
clean_codeblocks
fileutils.clean_files
fileutils.clean_directories