| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> | |
| <html><head><title>Python: module __init__</title> | |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | |
| </head><body bgcolor="#f0f0f8"> | |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> | |
| <tr bgcolor="#7799ee"> | |
| <td valign=bottom> <br> | |
| <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>__init__</strong></big></big></font></td | |
| ><td align=right valign=bottom | |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Crennie%5Cgitrepos%5Csynthtool%5Csynthtool%5C__init__.py">c:\users\rennie\gitrepos\synthtool\synthtool\__init__.py</a></font></td></tr></table> | |
| <p><tt>Synthtool synthesizes libraries from disparate sources.</tt></p> | |
| <p> | |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | |
| <tr bgcolor="#aa55cc"> | |
| <td colspan=3 valign=bottom> <br> | |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> | |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> | |
| <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__main__.html">__main__</a><br> | |
| </td><td width="25%" valign=top><a href="sys.html">sys</a><br> | |
| </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> | |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | |
| <tr bgcolor="#eeaa77"> | |
| <td colspan=3 valign=bottom> <br> | |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> | |
| <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> | |
| <td width="100%"><dl><dt><a name="-copy"><strong>copy</strong></a> = move(sources: Iterable[Union[str, pathlib.Path]], destination: Union[str, pathlib.Path] = None, excludes: Iterable[Union[str, pathlib.Path]] = None, merge: Callable[[str, str, pathlib.Path], str] = None, required: bool = False) -> bool</dt><dd><tt>copy file(s) at source to current directory, preserving file mode.<br> | |
| <br> | |
| Args:<br> | |
| sources (ListOfPathsOrStrs): Glob pattern(s) to copy<br> | |
| destination (PathOrStr): Destination folder for copied files<br> | |
| excludes (ListOfPathsOrStrs): Glob pattern(s) of files to skip<br> | |
| merge (Callable[[str, str, Path], str]): Callback function for merging files<br> | |
| if there is an existing file.<br> | |
| required (bool): If required and no source files are copied, throws a MissingSourceError<br> | |
| <br> | |
| Returns:<br> | |
| True if any files were copied, False otherwise.</tt></dd></dl> | |
| <dl><dt><a name="-dont_overwrite"><strong>dont_overwrite</strong></a>(patterns: Iterable[Union[str, pathlib.Path]]) -> Callable[[str, str, pathlib.Path], str]</dt><dd><tt>Returns a merge function that doesn't overwrite the specified files.<br> | |
| <br> | |
| Pass the return value to <a href="#-move">move</a>() or <a href="#-copy">copy</a>() to avoid overwriting existing<br> | |
| files.</tt></dd></dl> | |
| <dl><dt><a name="-move"><strong>move</strong></a>(sources: Iterable[Union[str, pathlib.Path]], destination: Union[str, pathlib.Path] = None, excludes: Iterable[Union[str, pathlib.Path]] = None, merge: Callable[[str, str, pathlib.Path], str] = None, required: bool = False) -> bool</dt><dd><tt>copy file(s) at source to current directory, preserving file mode.<br> | |
| <br> | |
| Args:<br> | |
| sources (ListOfPathsOrStrs): Glob pattern(s) to copy<br> | |
| destination (PathOrStr): Destination folder for copied files<br> | |
| excludes (ListOfPathsOrStrs): Glob pattern(s) of files to skip<br> | |
| merge (Callable[[str, str, Path], str]): Callback function for merging files<br> | |
| if there is an existing file.<br> | |
| required (bool): If required and no source files are copied, throws a MissingSourceError<br> | |
| <br> | |
| Returns:<br> | |
| True if any files were copied, False otherwise.</tt></dd></dl> | |
| <dl><dt><a name="-replace"><strong>replace</strong></a>(sources: Iterable[Union[str, pathlib.Path]], before: str, after: str, flags: int = <RegexFlag.MULTILINE: 8>) -> int</dt><dd><tt>Replaces occurrences of before with after in all the given sources.<br> | |
| <br> | |
| Returns:<br> | |
| The number of times the text was found and replaced across all files.</tt></dd></dl> | |
| </td></tr></table><p> | |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | |
| <tr bgcolor="#55aa55"> | |
| <td colspan=3 valign=bottom> <br> | |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> | |
| <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> | |
| <td width="100%"><strong>__all__</strong> = ['copy', 'move', 'replace', 'dont_overwrite']</td></tr></table> | |
| </body></html> |