Ticket #43930

generate_packets.py: Use pathlib for file path handling

오픈 날짜: 2022-02-19 22:21 마지막 업데이트: 2022-02-22 21:10

Reporter:
소유자:
Type:
Status:
Closed
Component:
MileStone:
Priority:
5 - Medium
Severity:
5 - Medium
Resolution:
Fixed
File:
1

Details

Part of #43927. Using pathlib allows for clean, filesystem-agnostic handling of paths.

Ticket History (3/7 Histories)

2022-02-19 22:21 Updated by: alienvalkyrie
  • New Ticket "generate_packets.py: Use pathlib for file path handling" created
2022-02-20 11:58 Updated by: alienvalkyrie
  • 소유자 Update from (None) to alienvalkyrie
  • Milestone Update from 3.1.0 (closed) to 3.2.0
  • Component Update from General to Bootstrap
2022-02-20 13:15 Updated by: alienvalkyrie
  • Resolution Update from None to Accepted
댓글 올리기

In addition to cleaning up parts of the code, this patch finally makes it possible to run the script on Windows without running into issues due to mixed path separators.

2022-02-20 14:03 Updated by: cazfi
댓글 올리기

Reply To alienvalkyrie

In addition to cleaning up parts of the code, this patch finally makes it possible to run the script on Windows without running into issues due to mixed path separators.

I assume that by "path separators" you mean separator between a directory and its subdirectory, not separator between entire paths like in PATH environment variable and the like.

Is there a risk that this *introduces* mixed dir separators? The build system runs it with parameters given with '/' separator. If it then appends to that with '\' separators, the resulting path will contain both.

2022-02-20 21:14 Updated by: alienvalkyrie
댓글 올리기

Reply To cazfi

Reply To alienvalkyrie

In addition to cleaning up parts of the code, this patch finally makes it possible to run the script on Windows without running into issues due to mixed path separators.

I assume that by "path separators" you mean separator between a directory and its subdirectory, not separator between entire paths like in PATH environment variable and the like.

Yes, thank you. "path separators" was the wrong word to use there.

Is there a risk that this *introduces* mixed dir separators? The build system runs it with parameters given with '/' separator. If it then appends to that with '\' separators, the resulting path will contain both.

There is not – that kind of issue is precisely what pathlib is designed to handle. Since Windows file and directory names aren't allowed to contain slashes anyway, those are safely parsed as separating directories (in fact, until the point where a path is given to the OS or otherwise turned into a plain string, I believe slashes are used internally even for Windows paths).

To be sure, I tested the script on both Windows and Linux – on Windows, the verbose log messages (where paths are stringified) have backslashes in them (even where the build system passed paths with slashes, since every path passes through pathlib), but apart from that, everything is identical.

(Edited, 2022-02-20 21:15 Updated by: alienvalkyrie)
2022-02-22 21:10 Updated by: alienvalkyrie
  • Status Update from Open to Closed
  • Resolution Update from Accepted to Fixed

Edit

Please login to add comment to this ticket » Login