Open an (uncompressed) tar archive 'name'. 'mode' is either 'r' to read from an existing archive, 'a' to append data to an existing file or 'w' to create a new file overwriting an existing one. 'mode' defaults to 'r'. If 'fileobj' is given, it is used for
(self, name=None, mode="r", fileobj=None, format=None,
tarinfo=None, dereference=None, ignore_zeros=None, encoding=None,
errors="surrogateescape", pax_headers=None, debug=None,
errorlevel=None, copybufsize=None, stream=False)
| 1724 | extraction_filter = None # The default filter for extraction. |
| 1725 | |
| 1726 | def __init__(self, name=None, mode="r", fileobj=None, format=None, |
| 1727 | tarinfo=None, dereference=None, ignore_zeros=None, encoding=None, |
| 1728 | errors="surrogateescape", pax_headers=None, debug=None, |
| 1729 | errorlevel=None, copybufsize=None, stream=False): |
| 1730 | """Open an (uncompressed) tar archive 'name'. 'mode' is either 'r' to |
| 1731 | read from an existing archive, 'a' to append data to an existing |
| 1732 | file or 'w' to create a new file overwriting an existing one. 'mode' |
| 1733 | defaults to 'r'. |
| 1734 | If 'fileobj' is given, it is used for reading or writing data. If it |
| 1735 | can be determined, 'mode' is overridden by 'fileobj's mode. |
| 1736 | 'fileobj' is not closed, when TarFile is closed. |
| 1737 | """ |
| 1738 | modes = {"r": "rb", "a": "r+b", "w": "wb", "x": "xb"} |
| 1739 | if mode not in modes: |
| 1740 | raise ValueError("mode must be 'r', 'a', 'w' or 'x'") |
| 1741 | self.mode = mode |
| 1742 | self._mode = modes[mode] |
| 1743 | |
| 1744 | if not fileobj: |
| 1745 | if self.mode == "a" and not os.path.exists(name): |
| 1746 | # Create nonexistent files in append mode. |
| 1747 | self.mode = "w" |
| 1748 | self._mode = "wb" |
| 1749 | fileobj = bltn_open(name, self._mode) |
| 1750 | self._extfileobj = False |
| 1751 | else: |
| 1752 | if (name is None and hasattr(fileobj, "name") and |
| 1753 | isinstance(fileobj.name, (str, bytes))): |
| 1754 | name = fileobj.name |
| 1755 | if hasattr(fileobj, "mode"): |
| 1756 | self._mode = fileobj.mode |
| 1757 | self._extfileobj = True |
| 1758 | self.name = os.path.abspath(name) if name else None |
| 1759 | self.fileobj = fileobj |
| 1760 | |
| 1761 | self.stream = stream |
| 1762 | |
| 1763 | # Init attributes. |
| 1764 | if format is not None: |
| 1765 | self.format = format |
| 1766 | if tarinfo is not None: |
| 1767 | self.tarinfo = tarinfo |
| 1768 | if dereference is not None: |
| 1769 | self.dereference = dereference |
| 1770 | if ignore_zeros is not None: |
| 1771 | self.ignore_zeros = ignore_zeros |
| 1772 | if encoding is not None: |
| 1773 | self.encoding = encoding |
| 1774 | self.errors = errors |
| 1775 | |
| 1776 | if pax_headers is not None and self.format == PAX_FORMAT: |
| 1777 | self.pax_headers = pax_headers |
| 1778 | else: |
| 1779 | self.pax_headers = {} |
| 1780 | |
| 1781 | if debug is not None: |
| 1782 | self.debug = debug |
| 1783 | if errorlevel is not None: |
nothing calls this directly
no test coverage detected