Python 小技巧：路径检查函数

最新推荐文章于 2025-11-24 01:18:54 发布
原创 最新推荐文章于 2025-11-24 01:18:54 发布 · 392 阅读 · 7 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#python

研究目的

在对输入路径进行核查时，需要检查其是否存在、是否可访问，并记录错误信息。

1.0

  • 编写两个辅助函数
    • check_directory_path(path: Path) -> dict：返回一个字典，包含是否存在、是否可读、错误信息等。
    • check_file_path(path: Path) -> dict：同样返回一个字典，包含文件是否存在、是否可读、错误信息等。
from datetime import datetime
import logging
from pathlib import Path
from typing import Optional, Union, Tuple, Dict, Any
import os
import stat
import sys

def check_directory_path(path: Path) -> Tuple[bool, Dict[str, Any]]:
    """
    检查目录路径的可访问性
    
    参数:
        path: 要检查的Path对象
        
    返回:
        (是否有效, 错误信息字典)
    """
    result = {
        "exists": False,
        "readable": False,
        "writable": False,
        "error_messages": []
    }
    
    try:
        # 检查路径是否存在
        if not path.exists():
            result["error_messages"].append("目录不存在")
            return False, result
        
        result["exists"] = True
        
        # 检查是否是目录
        if not path.is_dir():
            result["error_messages"].append("路径不是目录")
            return False, result
        
        # 检查读权限
        try:
            # 尝试列出目录内容
            next(path.iterdir())
            result["readable"] = True
        except PermissionError:
            result["error_messages"].append("没有读取目录的权限")
        except StopIteration:
            # 空目录，但有读取权限
            result["readable"] = True
        except Exception as e:
            result["error_messages"].append(f"读取目录时发生错误: {e}")
        
        # 检查写权限
        try:
            # 尝试创建一个临时文件来测试写权限
            test_file = path / ".write_test"
            test_file.touch()
            test_file.unlink()  # 删除测试文件
            result["writable"] = True
        except PermissionError:
            result["error_messages"].append("没有写入目录的权限")
        except Exception as e:
            result["error_messages"].append(f"测试目录写入权限时发生错误: {e}")
        
        # 如果没有错误消息，则目录可访问
        is_valid = len(result["error_messages"]) == 0
        return is_valid, result
        
    except Exception as e:
        result["error_messages"].append(f"检查目录时发生意外错误: {e}")
        return False, result

def check_file_path(path: Path) -> Tuple[bool, Dict[str, Any]]:
    """
    检查文件路径的可访问性
    
    参数:
        path: 要检查的Path对象
        
    返回:
        (是否有效, 错误信息字典)
    """
    result = {
        "exists": False,
        "readable": False,
        "writable": False,
        "error_messages": []
    }
    
    try:
        # 检查路径是否存在
        if not path.exists():
            result["error_messages"].append("文件不存在")
            return False, result
        
        result["exists"] = True
        
        # 检查是否是文件
        if not path.is_file():
            result["error_messages"].append("路径不是文件")
            return False, result
        
        # 检查读权限
        try:
            with open(path, 'rb'):
                pass
            result["readable"] = True
        except PermissionError:
            result["error_messages"].append("没有读取文件的权限")
        except Exception as e:
            result["error_messages"].append(f"读取文件时发生错误: {e}")
        
        # 检查写权限
        try:
            # 尝试以追加模式打开文件来测试写权限
            with open(path, 'ab'):
                pass
            result["writable"] = True
        except PermissionError:
            result["error_messages"].append("没有写入文件的权限")
        except Exception as e:
            result["error_messages"].append(f"测试文件写入权限时发生错误: {e}")
        
        # 如果没有错误消息，则文件可访问
        is_valid = len(result["error_messages"]) == 0
        return is_valid, result
        
    except Exception as e:
        result["error_messages"].append(f"检查文件时发生意外错误: {e}")
        return False, result

def check_path(path: Path) -> Tuple[bool, Dict[str, Any]]:
    """
    检查路径的可访问性，根据路径类型调用相应的检查函数
    
    参数:
        path: 要检查的Path对象
        
    返回:
        (是否有效, 错误信息字典)
    """
    logging.info(f"开始检查路径: {path}")
    
    if path.is_file():
        logging.info("路径是文件，进行文件检查")
        return check_file_path(path)
    elif path.is_dir():
        logging.info("路径是目录，进行目录检查")
        return check_directory_path(path)
    else:
        # 路径不存在或其他情况
        result = {
            "exists": False,
            "readable": False,
            "writable": False,
            "error_messages": ["路径不存在或无法确定类型"]
        }
        logging.warning("路径不存在或无法确定类型")
        return False, result

def get_user_input() -> Path:
    """
    获取用户输入的路径并进行验证
    
    返回:
        标准化后的Path对象
    """
    while True:
        user_input = input("请输入路径: ").strip()
        
        # 第一步：检查输入是否为空
        if not user_input:
            print("输入不能为空，请重新输入。")
            logging.warning("用户输入了空路径")
            continue
        
        # 第二步：标准化路径
        try:
            normalized_path = normalize_path(user_input)
            logging.info(f"标准化后的路径: {normalized_path}")
        except Exception as e:
            print(f"路径标准化失败: {e}")
            logging.error(f"路径标准化失败: {user_input} - {e}")
            continue
        
        # 第三步：检查路径
        is_valid, check_result = check_path(normalized_path)
        
        # 记录检查结果
        if is_valid:
            logging.info("路径检查通过")
            print("路径有效且可访问。")
            return normalized_path
        else:
            logging.warning(f"路径检查未通过: {check_result['error_messages']}")
            print("路径存在问题:")
            for error in check_result['error_messages']:
                print(f"  - {error}")
            
            # 询问用户是否继续使用此路径
            choice = input("是否继续使用此路径? (y/n): ").strip().lower()
            if choice == 'y':
                logging.info("用户选择继续使用有问题的路径")
                return normalized_path
            else:
                logging.info("用户选择重新输入路径")
                print("请重新输入路径。")

1.5

使用 pathlib 模块优化后的代码，它更加符合 Python 3.0 的风格，并且利用了 pathlib 提供的面向对象方法来处理文件系统操作，更加简洁：

from datetime import datetime
import logging
from pathlib import Path
from typing import Optional, Union, List, Tuple
import sys

# 使用 pathlib 优化的检查函数
def check_directory_path(path: Path) -> Tuple[bool, List[str]]:
    """检查目录路径的可访问性"""
    errors = []
    
    if not path.exists():
        errors.append("目录不存在")
        return False, errors
    
    if not path.is_dir():
        errors.append("路径不是目录")
        return False, errors
    
    # 检查读权限 - 尝试列出目录内容
    try:
        # 使用 pathlib 的 iterdir() 方法检查读权限
        next(path.iterdir())
    except PermissionError:
        errors.append("没有读取目录的权限")
    except StopIteration:
        # 空目录，但有读取权限
        pass
    except Exception as e:
        errors.append(f"读取目录时发生错误: {e}")
    
    # 检查写权限 - 尝试创建和删除临时文件
    test_file = path / ".write_test.tmp"
    try:
        test_file.touch()
        test_file.unlink()  # 删除测试文件
    except PermissionError:
        errors.append("没有写入目录的权限")
    except Exception as e:
        errors.append(f"测试目录写入权限时发生错误: {e}")
    
    return len(errors) == 0, errors

def check_file_path(path: Path) -> Tuple[bool, List[str]]:
    """检查文件路径的可访问性"""
    errors = []
    
    if not path.exists():
        errors.append("文件不存在")
        return False, errors
    
    if not path.is_file():
        errors.append("路径不是文件")
        return False, errors
    
    # 检查读权限 - 尝试打开文件
    try:
        with path.open('rb') as f:
            # 尝试读取一个字节
            f.read(1)
    except PermissionError:
        errors.append("没有读取文件的权限")
    except Exception as e:
        errors.append(f"读取文件时发生错误: {e}")
    
    # 检查写权限 - 尝试以追加模式打开文件
    try:
        with path.open('ab'):
            pass
    except PermissionError:
        errors.append("没有写入文件的权限")
    except Exception as e:
        errors.append(f"测试文件写入权限时发生错误: {e}")
    
    return len(errors) == 0, errors

def check_path(path: Path) -> Tuple[bool, List[str]]:
    """检查路径可访问性，只在遇到问题时记录日志"""
    if path.is_file():
        return check_file_path(path)
    elif path.is_dir():
        return check_directory_path(path)
    else:
        # 路径不存在时记录日志
        logging.warning(f"路径不存在或类型未知: {path}")
        return False, ["路径不存在或无法确定类型"]

# 用户输入处理
def get_user_input() -> Path:
    """获取用户输入的路径并进行验证"""
    while True:
        user_input = input("请输入路径: ").strip()
        
        if not user_input:
            print("输入不能为空，请重新输入。")
            logging.warning("用户输入了空路径")
            continue
        
        try:
            normalized_path = normalize_path(user_input)
        except Exception as e:
            logging.error(f"路径标准化失败: {e}")
            print(f"路径标准化失败: {e}")
            continue
        
        is_valid, errors = check_path(normalized_path)
        
        if is_valid:
            return normalized_path
        
        print("路径存在问题:")
        for error in errors:
            print(f"  - {error}")
        
        choice = input("是否继续使用此路径? (y/n): ").strip().lower()
        if choice == 'y':
            logging.warning(f"用户选择继续使用有问题的路径: {normalized_path}")
            return normalized_path
        else:
            print("请重新输入路径。")

主要优化点：

  1. 完全使用 pathlib 方法：

    • 使用 path.exists(), path.is_dir(), path.is_file() 等 pathlib 方法替代 os 模块的函数
    • 使用 path.iterdir() 检查目录读取权限
    • 使用 path.touch() 和 path.unlink() 测试目录写入权限
    • 使用 path.open() 方法检查文件读写权限

  2. 遵循 EAFP (Easier to Ask for Forgiveness than Permission) 原则：

    • 直接尝试执行操作并捕获异常，而不是先检查权限
    • 这提供了更准确的权限检查，因为权限可能在检查和实际操作之间发生变化

  3. Pythonic 的代码风格：

    • 充分利用 pathlib 的面向对象特性
    • 代码更简洁、更易读

2.0

方法1：使用 os.access()

# 检查写权限
if not os.access(path, os.W_OK):
    errors.append("没有写入目录的权限")

  • 优点：

    • 非常快速，不涉及任何磁盘 I/O
    • 不会创建任何临时文件

  • 缺点：

    • 可能存在 TOCTOU (Time of Check to Time of Use) 竞争条件
    • 在某些特殊情况下可能不准确（如磁盘已满、权限在检查后立即更改等）

方法2：使用 pathlib

# 如果目录不存在，尝试创建它来测试写权限
if not path.exists():
    try:
        path.mkdir(parents=True, exist_ok=True)
        # 创建成功，说明有写权限
        path.rmdir()  # 删除测试目录
    except PermissionError:
        errors.append("没有在当前目录创建子目录的权限")
    except Exception as e:
        errors.append(f"测试目录创建权限时发生错误: {e}")

结合两种方法

from datetime import datetime
import logging
from pathlib import Path
from typing import Optional, Union, List, Tuple, Dict
import os
import sys
import tempfile

def check_directory_path(path: Path) -> Tuple[bool, List[str]]:
    """检查目录路径的可访问性"""
    errors = []
    
    if not path.exists():
        errors.append("目录不存在")
        return False, errors
    
    if not path.is_dir():
        errors.append("路径不是目录")
        return False, errors
    
    # 检查读权限
    if not os.access(path, os.R_OK):
        errors.append("没有读取目录的权限")
    else:
        # 对通过快速检查的进行实际验证
        try:
            # 尝试列出目录内容（但限制数量）
            with os.scandir(path) as it:
                next(it)  # 尝试获取第一个条目
        except StopIteration:
            pass  # 空目录是正常的
        except PermissionError:
            errors.append("实际读取目录失败：权限不足")
        except Exception as e:
            errors.append(f"读取目录时发生错误: {e}")
    
    # 检查写权限 - 使用快速检查加验证的方式
    if not os.access(path, os.W_OK):
        errors.append("没有写入目录的权限")
    else:
        # 对通过快速检查的进行实际验证
        # 替换原来的写权限检查
        try:
            with tempfile.TemporaryDirectory(dir=path) as _:
                pass  # 成功创建即表示有写权限
        except PermissionError:
            errors.append("实际写入目录失败：权限不足")
        except Exception as e:
            errors.append(f"测试目录写入权限时发生错误: {e}")
    
    return len(errors) == 0, errors

def check_file_path(path: Path) -> Tuple[bool, List[str]]:
    """检查文件路径的可访问性"""
    errors = []
    
    if not path.exists():
        errors.append("文件不存在")
        return False, errors
    
    if not path.is_file():
        errors.append("路径不是文件")
        return False, errors
    
    # 检查读权限
    # 使用os.access进行快速初步检查
    if not os.access(path, os.R_OK):
        errors.append("没有读取文件的权限")
    else:
        # 对通过初步检查的进行实际读取验证
        try:
            with path.open('rb') as f:
                f.read(1) # 尝试读取一个字节
        except PermissionError:
            errors.append("没有读取文件的权限")
        except Exception as e:
            errors.append(f"读取文件时发生错误: {e}")
    
    # 检查写权限
    if not os.access(path, os.W_OK):
        errors.append("没有写入文件的权限")
    else:
        # 对通过初步检查的进行实际写入验证
        try:
            with path.open('ab'):
                pass  # 尝试以追加模式打开
        except PermissionError:
            errors.append("没有写入文件的权限")
        except Exception as e:
            errors.append(f"测试文件写入权限时发生错误: {e}")
    
    return len(errors) == 0, errors

def check_path(path: Path) -> Tuple[bool, List[str]]:
    """检查路径可访问性"""
    if path.is_file():
        return check_file_path(path)
    elif path.is_dir():
        return check_directory_path(path)
    else:
        logging.warning(f"路径不存在或类型未知: {path}")
        return False, ["路径不存在或无法确定类型"]

# 用户输入处理
def get_user_input() -> Path:
    """获取用户输入的路径并进行验证"""
    while True:
        user_input = input("请输入路径: ").strip()
        
        if not user_input:
            print("输入不能为空，请重新输入。")
            logging.warning("用户输入了空路径")
            continue
        
        try:
            normalized_path = normalize_path(user_input)
        except Exception as e:
            logging.error(f"路径标准化失败: {e}")
            print(f"路径标准化失败: {e}")
            continue
        
        is_valid, errors = check_path(normalized_path)
        
        if is_valid:
            return normalized_path
        
        print("路径存在问题:")
        for error in errors:
            print(f"  - {error}")
        
        choice = input("是否继续使用此路径? (y/n): ").strip().lower()
        if choice == 'y':
            logging.warning(f"用户选择继续使用有问题的路径: {normalized_path}")
            return normalized_path
        else:
            print("请重新输入路径。")
【模块化编程】Python文件路径检查、跳转模块
十二月的猫
04-16 1369
这篇【模块化编程】文章将详细介绍如何在Python中高效管理文件路径，包括路径检查与目录跳转的实用模块化实现。你将学习使用os和pathlib模块进行路径存在性验证、相对/绝对路径转换，以及跨平台安全的目录切换操作。文章包含可复用的代码片段，演示如何封装路径操作为独立函数，处理常见异常情况，并优化文件系统交互流程。无论是自动化脚本开发还是大型项目管理，这些技巧都能显著提升代码的健壮性和可维护性。
Python绘图技巧：应力应变曲线动画Python绘制及弹性模量拟合
Rockyoung
06-17 1498
应力应变数据拟合
搜索文件的路径(4条命令)
07-20 432
which命令 which命令：显示(shell)命令的完整路径。 格式:which [options] [--] programname [...] 参数： 参数 作用 -n -n：制定文件名长度，指定的长度必须大于或等于所有文件中最长的文件名； -p 与-n参数相同，但此处的包含了文件的路径； -w 指定输出时栏位的宽度； -V 显示版本信息。 例子：...
Python 在自动化运维时常用到的方法
Persus & Xie
09-30 685
内容展示了在自动化运维中常用的 Python 文件操作和目录管理方法。模块为操作系统交互提供了强大的工具集，结合文件读写操作，可以实现高效的自动化任务。
Python判断路径合法性
清风韶华的博客
03-15 2219
【代码】Python判断路径合法性。
Python 正则表达式验证Windows路径
计算机视觉
11-06 3174
1. Dirve letter paths (?x)\A [a-zA-Z]:\\ # Drive (?:[^\\/:*?"<>|\r\n]+\\)* # Folder [^\\/:*?"<>|\r\n]* # File \Z eg. C:\DELL\nihao.jgp 2. Drive letter and paths \A (?:[
Python小技巧：从包含路径的字符串中获取文件名
Mr_K_night的博客
05-19 2074
注意，如果文件名中包含多个点号.，则这个方法只会去掉第一个点号及其后面的部分，不会去掉其他点号及其后面的部分。具体来说，这段代码使用了字符串的split()方法，将字符串按照斜杠字符/进行分割得到一个字符串列表，然后使用[-1]选取列表中的最后一个元素，即文件名部分。具体来说，这段代码使用了字符串的split()方法，将文件名按照点号.进行分割得到一个字符串列表，然后使用[0]选取列表中的第一个元素，即不带扩展名的部分。这个字符串可以用于文件操作中的一些操作，例如读取文件或将文件名用于输出文件的构建。
查看Python安装路径以及安装包路径小技巧
09-22
这个命令调用了Python的`distutils.sysconfig`模块，并使用`get_python_lib`函数获取了Python的site-packages目录的路径。对于上面的例子，它将输出路径`C:\Python27\Lib\site-packages`，这个路径是Python包的安装...
Python小技巧：使用pypdf2对pdf文件合并、分割、加密
06-01 2905
朋友需要对一个pdf文件进行分割，在网上查了查发现这个pypdf2可以完成这些操作，所以就研究了下这个库，并做一些记录。首先pypdf2是python3版本的，在之前的2版本有一个对应pypdf库。 可以使用pip直接安装： 官方文档：pythonhosted.org/PyPDF2/ 里面主要有这几个类： PdfFileReader 。 该类主要提供了对pdf文件的读操作，其...
python-sandbox:我修改过的各种小型python项目
03-25
2. **文件操作**：Python提供了丰富的文件I/O接口，包括读写文本文件、二进制文件、处理文件路径、以及使用上下文管理器确保文件正确关闭等。 3. **模块与包的使用**：Python中的模块允许将代码组织成独立的文件，...
python：Fastapi 查询参数及路径参数校验
一名小测试
01-27 4762
这次主要聊聊Fastapi中，查询参数和路径参数的使用及校校验，Path是为路径参数声明校验和元数据，而 Query是 为查询参数声明校验和元数据。 两个的区别就是，路径参数是跟在路径后面的，例如：/path/1，1 即为路径参数；查询参数是键值对传值，例如：/path/q=1，q=1 即为查询参数 介绍完后，下面进入实例操作环节… 查询参数和字符串校验 查询参数校验 FastAPI 允许参数声明额外的信息和校验，以下面的应用程序为例： fromtypingimportOpti...
python文件处理-检查文件名/路径是否正确
weixin_30235225的博客
08-16 1116
内容涉及：检查路径是否存在，文件名长度是否一直，将重复的文件夹重命名 # -*- coding: utf-8 -*- import os import sys import numpy as np import copy from collections import Counter ''' 标注文件夹名：data ，csv文件深度4 原片文件夹名：image ...
python 复制文件夹校验_在python中验证文件名
weixin_31499265的博客
12-29 284
这些思想被实现为烧瓶中的safe_join()函数：def safe_join(directory, filename):"""Safely join `directory` and `filename`.Example usage::@app.route('/wiki/')def wiki_page(filename):filename = safe_join(app.config['WIKI_...
怎样使用 Python 来判断一个路径是否存在判断一个路径是文件还是目录
热门推荐
12-13 3万+
怎样使用 Python 来判断一个路径是否存在判断一个路径是文件还是目录判断一个路径是否存在可以判断一个文件或目录（文件夹）是否存在import os.path os.path.exists(path); 判断一个文件是否存在import os.path os.path.isfile(path); 判断一个目录（文件夹）是否存在import os.path os.path.isdir(path);
python检测给定的路径是否存在的方法
shannya_zhima的博客
02-22 2673
os.path 模块提供了函数用于检测给定的路径是否存在 1、path 参数所指的文件或文件夹存在，调用os.path.exists(path) 返回 True，否则返回 False >>> os.path.exists('C:\\Windows') True >>> os.path.exists('C:\\Win') False 2、path 参数存在并且是一个文件，调用 os.path.isfile(path) 返回 True，否则返回 False &.
python检查路径有效性
dongyu1703的博客
08-18 8135
如果你提供的路径不存在，许多 Python 函数就会崩溃并报错。os.path 模块提供了一些函数，用于检测给定的路径是否存在，以及它是文件还是文件夹。 • 如果 path 参数所指的文件或文件夹存在，调用 os.path.exists(path)将返回 True，否则返回 False。 • 如果 path 参数存在，并且是一个文件，调用 os.path.isfile(path)将返回 True，...
Python全栈开发项目——AI智能聊天机器人
最新发布
qiao_yue的博客
11-24 371
本项目实现了AI聊天功能，具有语音输入和聊天背景自定义等亮点功能
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值