dwipe 1.0.3__tar.gz → 1.0.5__tar.gz

dwipe-1.0.5/.gitignore

@@ -0,0 +1,6 @@
+.vscode/
+*/__pycache/
+venv.zd/
+*.pyc
+*egg-info*
+dist/

{dwipe-1.0.3/src/dwipe.egg-info → dwipe-1.0.5}/PKG-INFO

@@ -1,20 +1,18 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dwipe
-Version: 1.0.3
+Version: 1.0.5
 Summary: A tool to wipe disks and partitions for Linux
-Author-email: Joe Defen <joedef@google.com>
-License: MIT
-Project-URL: Homepage, https://github.com/joedefen/dwipe
-Project-URL: Bug Tracker, https://github.com/joedefen/dwipe/issues
 Keywords: disk,partition,wipe,clean,scrub
+Author-email: Joe Defen <joedef@google.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: POSIX :: Linux
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: psutil>=5.9
+Requires-Dist: importlib-metadata; python_version<"3.8"
+Project-URL: Bug Tracker, https://github.com/joedefen/dwipe/issues
+Project-URL: Homepage, https://github.com/joedefen/dwipe
 
 # dwipe
 `dwipe` is tool to wipe disks and partitions for Linux helps secure you data. `dwipes` aims to reduce mistakes by providing ample information about your devices during selection.

dwipe-1.0.5/deploy

@@ -0,0 +1,9 @@
+#!/bin/bash
+script_dir=$(dirname "$0")
+set -ex
+cd ${script_dir}
+rm -rf ./dist
+python3 -m pip install build --break-system-packages
+python3 -m build
+pip install -e . --break-system-packages
+

{dwipe-1.0.3/src → dwipe-1.0.5}/dwipe/main.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
-""" TBD
-
-
+"""
+dwipe: curse based tool to wipe physical disks or partitions including
+  markers to know their state when wiped.
 """
 # pylint: disable=too-many-branches,too-many-statements,import-outside-toplevel
 # pylint: disable=too-many-instance-attributes,invalid-name
@@ -79,6 +79,7 @@ class WipeJob:
         self.total_written = 0
         self.wr_hists = []  # list of (mono, written)
         self.done = False
+        self.exception = None # in case of issues
 
     @staticmethod
     def start_job(device_path, total_size, opts):
@@ -185,38 +186,43 @@ class WipeJob:
         self.total_written = 0  # Track total bytes written
         is_random = self.opts.random
 
-        with open(self.device_path, 'wb') as device:
-            # for loop in range(10000000000):
-            offset = 0
-            chunk = memoryview(WipeJob.zero_buffer)
-            while True:
-                if self.do_abort:
-                    break
-                if is_random:
-                    offset = random.randint(0, WipeJob.BUFFER_SIZE - WipeJob.WRITE_SIZE)
-                    # Use memoryview to avoid copying the data
-                    chunk = memoryview(WipeJob.buffer)[offset:offset + WipeJob.WRITE_SIZE]
-
-                if self.opts.dry_run:
-                    bytes_written = self.total_size // 120
-                    time.sleep(0.25)
-                else:
-                    try:
-                        bytes_written = device.write(chunk)
-                    except Exception:
-                        bytes_written = 0
-                self.total_written += bytes_written
-                # Optional: Check for errors or incomplete writes
-                if bytes_written < WipeJob.WRITE_SIZE:
-                    break
-                if self.opts.dry_run and self.total_written >= self.total_size:
-                    break
-            # clear the beginning of device whether aborted or not
-            # if we have started writing + status in JSON
-            if not self.opts.dry_run and self.total_written > 0 and is_random:
-                device.seek(0)
-                # chunk = memoryview(WipeJob.zero_buffer)
-                bytes_written = device.write(self.prep_marker_buffer(is_random))
+        try:
+            with open(self.device_path, 'wb') as device:
+                # for loop in range(10000000000):
+                offset = 0
+                chunk = memoryview(WipeJob.zero_buffer)
+                while True:
+                    # foo = 1/0  # to force exception only
+                    if self.do_abort:
+                        break
+                    if is_random:
+                        offset = random.randint(0, WipeJob.BUFFER_SIZE - WipeJob.WRITE_SIZE)
+                        # Use memoryview to avoid copying the data
+                        chunk = memoryview(WipeJob.buffer)[offset:offset + WipeJob.WRITE_SIZE]
+
+                    if self.opts.dry_run:
+                        bytes_written = self.total_size // 120
+                        time.sleep(0.25)
+                    else:
+                        try:
+                            bytes_written = device.write(chunk)
+                        except Exception:
+                            bytes_written = 0
+                    self.total_written += bytes_written
+                    # Optional: Check for errors or incomplete writes
+                    if bytes_written < WipeJob.WRITE_SIZE:
+                        break
+                    if self.opts.dry_run and self.total_written >= self.total_size:
+                        break
+                # clear the beginning of device whether aborted or not
+                # if we have started writing + status in JSON
+                if not self.opts.dry_run and self.total_written > 0:
+                    device.seek(0)
+                    # chunk = memoryview(WipeJob.zero_buffer)
+                    bytes_written = device.write(self.prep_marker_buffer(is_random))
+        except Exception:
+            self.exception = traceback.format_exc()
+
         self.done = True
 
 class DeviceInfo:
@@ -284,6 +290,7 @@ class DeviceInfo:
             entry.fstype = device.get('fstype', '')
             if entry.fstype is None:
                 entry.fstype = ''
+            entry.type = device.get('type', '')
             entry.label = device.get('label', '')
             if not entry.label:
                 entry.label=device.get('partlabel', '')
@@ -313,7 +320,7 @@ class DeviceInfo:
 
                # Run the `lsblk` command and get its output in JSON format with additional columns
         result = subprocess.run(['lsblk', '-J', '--bytes', '-o',
-                    'NAME,MAJ:MIN,FSTYPE,LABEL,PARTLABEL,FSUSE%,SIZE,MOUNTPOINTS', ],
+                    'NAME,MAJ:MIN,FSTYPE,TYPE,LABEL,PARTLABEL,FSUSE%,SIZE,MOUNTPOINTS', ],
                     stdout=subprocess.PIPE, text=True, check=False)
         parsed_data = json.loads(result.stdout)
         entries = {}
@@ -407,47 +414,10 @@ class DeviceInfo:
 
     def get_disk_partitions(self, nss):
         """ Determine which partitions we want some are bogus like zram """
-
-        def whitelisted(device_name):
-            """Check if device_name matches any pattern in whitelist
-            which are the disk devices."""
-            WHITELIST = ['nvme*', 'sd*', 'hd*', 'mmcblk*']
-            for pattern in WHITELIST:
-                if fnmatch(device_name, pattern):
-                    return True
-            return False
-
-        def blacklisted(device_name):
-            """Check if device_name matches any pattern in black list
-              which are know not to be physical disks."""
-            BLACKLIST = ['zram*', 'ram*', 'dm-*', 'loop*', 'sr*']
-            for pattern in BLACKLIST:
-                if fnmatch(device_name, pattern):
-                    return 'blkLst'
-            return ''
-
-        def writable(device_name):
-            """Check if the device is writable."""
-            device_path = f'/dev/{device_name}'
-            try: # Check if the device file exists and is writable
-                return os.access(device_path, os.W_OK)
-            except FileNotFoundError:
-                return False
-
         ok_nss = {}
         for name, ns in nss.items():
-            if ns.major in self.disk_majors or whitelisted(name):
+            if ns.type in ('disk', 'part'):
                 ok_nss[name] = ns
-                continue
-            if blacklisted(name):
-                continue
-            if writable(name):
-                if self.DB:
-                    print(r'DB:include {repr(name)} [not white/black but writable]')
-                ok_nss[name] = ns
-                continue
-            if self.DB:
-                print(r'DB:exclude {repr(name)} [not white/black but unwritable]')
         return ok_nss
 
     def compute_field_widths(self, nss):
@@ -755,6 +725,8 @@ class DiskWipe:
         line += ' Stop' if self.job_cnt > 0 else ''
         line += f' quit ?:help /{self.prev_filter}  Mode='
         line += f'{"Random" if self.opts.random else "Zeros"}'
+        if self.opts.dry_run:
+            line += ' DRY-RUN'
         # for action in self.actions:
             # line += f' {action[0]}:{action}'
         return line[1:]
@@ -834,15 +806,24 @@ class DiskWipe:
                             to='s' if partition.job.do_abort else 'W'
                             self.set_state(partition, to=to)
                             partition.dflt = to
-                            partition.job = None
                             partition.mounts = []
                             self.job_cnt -= 1
+                            if partition.job.exception:
+                                self.win.stop_curses()
+                                print('\n\n\n==========   ALERT  =========\n')
+                                print(f' FAILED: wipe {repr(partition.name)}')
+                                print(partition.job.exception)
+                                input('\n\n===== Press ENTER to continue ====> ')
+                                self.win._start_curses()
+
+                            partition.job = None
                     if partition.job:
                         elapsed, pct, rate, until = partition.job.get_status()
                         partition.state = pct
                         partition.mounts = [f'{elapsed} {rate} REM:{until}']
 
-                    if partition.parent and self.partitions[partition.parent].state == 'Lock':
+                    if partition.parent and partition.parent in self.partitions and (
+                            self.partitions[partition.parent].state == 'Lock'):
                         continue
 
                     if wanted(name) or partition.job:

dwipe-1.0.5/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["flit_core>=3.4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "dwipe"
+version = "1.0.5"
+description = "A tool to wipe disks and partitions for Linux"
+authors = [
+    { name = "Joe Defen", email = "joedef@google.com" }
+]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+keywords = ["disk", "partition", "wipe", "clean", "scrub"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux"
+]
+dependencies = [
+    'importlib-metadata; python_version<"3.8"',
+]
+
+[project.urls]
+"Homepage" = "https://github.com/joedefen/dwipe"
+"Bug Tracker" = "https://github.com/joedefen/dwipe/issues"
+
+[project.scripts]
+dwipe = "dwipe.main:main"

dwipe-1.0.5/run.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+SRC="$(dirname "$0")/src"
+
+set -x
+##### choose one:
+
+PYTHONPATH="$SRC" python3 -m dwipe.main "$@"
+# PYTHONPATH="$SRC" python3 src/dwipe/main.py "$@"

dwipe-1.0.3/PKG-INFO

@@ -1,74 +0,0 @@
-Metadata-Version: 2.1
-Name: dwipe
-Version: 1.0.3
-Summary: A tool to wipe disks and partitions for Linux
-Author-email: Joe Defen <joedef@google.com>
-License: MIT
-Project-URL: Homepage, https://github.com/joedefen/dwipe
-Project-URL: Bug Tracker, https://github.com/joedefen/dwipe/issues
-Keywords: disk,partition,wipe,clean,scrub
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: POSIX :: Linux
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: psutil>=5.9
-
-# dwipe
-`dwipe` is tool to wipe disks and partitions for Linux helps secure you data. `dwipes` aims to reduce mistakes by providing ample information about your devices during selection.
-
-> **Quick Start:**
-> * Install `dwipe` using `pipx install dwipe`, or however you install python scripts from PyPi.org.
-> * Run `dwipe` from a terminal and observe the context sensitive help on the 1st line.
-
-To help with your disk scrubbing, `dwipe`:
-* shows disks and partitions that can be wiped along with selected information to help choose them (i.e.,; labels, sizes, and types); disallowed are mounted devices and overlapping wipes and manually "locked" disks.
-* updates the device list when it changes;  newly added devices are marked differently to make it easier to see them.
-* supports starting multiple wipes, shows their progress, and shows completion states.
-* supports either zeroing devices or filling with random data.
-* supports filtering for devices by name/pattern in case of too many for one screen, etc.
-* supports stopping wipes in progress.
-
-`dwipe` shows file system labels, and if not the partition label.  It is best practice to label partitions and file systems well to make selection easier.
-  
-## Usage
-> Simply run `dwipe` from the command line w/o arguments normally. Its command line arguments mostly for debugging including "--dry-run" which lets you test/practice the interface w/o risk.
-
-Here is a typical screen:
-
-![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-main-screen.png?raw=true)
-
-The possible state values and meanings are:
-* **-** : indicates the device is ready for wiping if desired.
-* **^** : similar to **-**, but also indicates the device was added after `dwipe` started
-* **Mnt** :  the partition is mounted or the disk has partitions that are mounted.  You cannot wipe the device in this state.
-* **N%** : if a percent is seen, then a wipe is in progress.
-* **STOP** :  indicates that a wipe is being stopped.
-* **s** :  indicates that a wipe was stopped (so the device is partly wiped) and wiping can be restarted.
-* **W** :  indicates that a wipe was completed and wiping can be restarted.
-* **Lock** :  indicates that the disk is manually locked, its partitions are hidden, and you cannot wipe the disk or its partitions.
-* **Unlk** :  indicates that the disk was manually unlocked after a manual lock; this is a transitory state.
-
-The top line shows available actions and other info. Some actions are context sensitive:
-* **w** : **wipe** : wipe the selected device; before starting, you must confirm your intent.
-* **s** : **stop** : stops the selected wipe in progress (can take a while).
-* **S** : **Stop** : stops all wipes in progress (can take a while).
-* **q** : **quit** : quits the app after stopping wipes in progress.
-* **?** : **help** : bring up help screen with all actions and navigation keys explained.
-* **/** : **search** : limits the show devices to those matching the given regex plus all wipes in progress.
-
-The top line shows the "Mode" which is Random or Zeros. For some disks, zeroing may be faster than random.  Typing **r** toggles the mode (this is seen on the help screen). When Random, a wiped device is filled with random data and then the first 16KB is zeroed.
-
-The write rate and estimating remaining times are shown when wiping a device.  Due to write queueing, the initial rates may be inflated, final rates are deflated, and the times are optimistic.
-
-The 'W' (Wiped) and 's' (partly wiped) states are disk persistent.  For those states, more information is provided about the wipe including when and percent complete.
-
-
-### The Help Screen
-When **?** is typed, the help screen looks like:
-
-![dwipe-help](https://raw.githubusercontent.com/joedefen/dwipe/master/resources/dwipe-help-screen.png?raw=true)
-
-You can navigate the list of devices with arrow keys and vi-like keys.

dwipe-1.0.3/pyproject.toml

@@ -1,89 +0,0 @@
-# HOW TO DEVELOP
-
-#
-# Prep Work (ensure need modules are up-to-date):
-#   sudo apt install python3-pip
-#   sudo apt install python3-pip-whl
-#   pip install build --break-system-packages
-#   sudo apt install twine
-#   -- antiquated way
-#      sudo pacman -Syu python-pip
-#      sudo pacman -Syu python-build
-#      sudo pacman -Syu python-twine
-#   -- antiquated way
-#      python3 -m pip install --upgrade pip
-#      python3 -m pip install --upgrade build
-#      python3 -m pip install --upgrade twine
-#
-# Optionally, `python3 -m venv venv`, and then
-#   - source env/bin/activate # to activate
-#   - deactivate # to deactivate
-# 
-# For a "live" local install:
-#  ./deploy  # uninstall: pip uninstall dwipe # to remove
-# To run:   ./run.sh
-
-# HOW TO PUBLISH...
-# PUBLIC Build and deploy (from project directory):
-#   ## BUMP the version (below in [project])
-#   rm -rf dist && python3 -m build; ls dist/. && python3 -m twine upload dist/*
-#       NOTE:   # keyring --disable # may be required
-#     ## Enter __token__ and the saved TOKEN (in bitwarden)
-#   pipx upgrade dwipe || pipx install dwipe # >= python3.11
-#   --OR-- sudo python3 -m pip install dwipe # <= python3.10
-#   ## VISIT  https://pypi.org/project/dwipe and delete old versions
-#
-# TEST Build and test (from project directory):
-#   ## BUMP the version (below in [project])
-#   rm -r dist; python3 -m build
-#   python3 -m twine upload --repository testpypi dist/* # keyring --disable # may be required
-#     ## Enter __token__ and the saved TOKEN (in bitwarden)
-#   sudo python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --no-deps --break-system-packages dwipe
-#   ## VISIT  https://test.pypi.org/project/dwipe and delete old versions
-
-[build-system]
-requires = ["setuptools>=42", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "dwipe"
-version = "1.0.3"
-description = "A tool to wipe disks and partitions for Linux"
-authors = [
-    { name = "Joe Defen", email = "joedef@google.com" }
-]
-readme = "README.md"
-license = { text = "MIT" }
-requires-python = ">=3.8"
-
-keywords = ["disk", "partition", "wipe", "clean", "scrub" ]
-
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: POSIX :: Linux"
-]
-dependencies = [
-    'importlib-metadata; python_version<"3.8"',
-    'psutil>=5.9',
-]
-
-[project.urls]
-"Homepage" = "https://github.com/joedefen/dwipe"
-"Bug Tracker" = "https://github.com/joedefen/dwipe/issues"
-
-[project.scripts]
-dwipe = "dwipe.main:main"
-
-[tool.setuptools]
-package-dir = {"" = "src"}
-
-[tool.setuptools.packages.find]
-where = ["src"]
-
-[tool.setuptools.package-data]
-
-exclude = [
-    "__pycache__",
-]
-

dwipe-1.0.3/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

dwipe-1.0.3/src/dwipe.egg-info/SOURCES.txt

@@ -1,12 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-src/dwipe/PowerWindow.py
-src/dwipe/__init__.py
-src/dwipe/main.py
-src/dwipe.egg-info/PKG-INFO
-src/dwipe.egg-info/SOURCES.txt
-src/dwipe.egg-info/dependency_links.txt
-src/dwipe.egg-info/entry_points.txt
-src/dwipe.egg-info/requires.txt
-src/dwipe.egg-info/top_level.txt

dwipe-1.0.3/src/dwipe.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

dwipe-1.0.3/src/dwipe.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-dwipe = dwipe.main:main

dwipe-1.0.3/src/dwipe.egg-info/requires.txt

@@ -1,4 +0,0 @@
-psutil>=5.9
-
-[:python_version < "3.8"]
-importlib-metadata

dwipe-1.0.3/src/dwipe.egg-info/top_level.txt

@@ -1 +0,0 @@
-dwipe