├── .github ├── ISSUE_TEMPLATE │ └── bug_report.md └── workflows │ └── deploy.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── README.md ├── scripts └── website-update.bash ├── setup.py └── wslpy ├── __core__ ├── __init__.py ├── access.py └── check.py ├── __init__.py ├── __internal__.py ├── convert.py ├── exec.py ├── helper.py ├── system.py ├── tests ├── __init__.py ├── test_convert.py └── test_internal.py └── win.py /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: Bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Background Information:** 11 | - Windows Build: [e.g. 17704] 12 | - WSL: [e.g. Ubuntu 16.04] 13 | - WSL Version: [e.g. version 1 or 2] 14 | - Version: [e.g. 1.5] 15 | 16 | **Describe the bug** 17 | A clear and concise description of what the bug is. 18 | 19 | **To Reproduce** 20 | Steps to reproduce the behavior: 21 | 22 | **Expected behavior** 23 | A clear and concise description of what you expected to happen. 24 | 25 | **Additional context** 26 | Add any other context about the problem here. 27 | -------------------------------------------------------------------------------- /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | name: CD 2 | on: 3 | push: 4 | branches: 5 | - master 6 | jobs: 7 | build: 8 | name: Generate 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v2 12 | - name: Setup & Build 13 | run: | 14 | pip3 install pdoc3 15 | pdoc3 --html wslpy/ 16 | - name: Deploy 17 | env: 18 | GH_TOKEN: ${{ secrets.GIT_DEPLOY_KEY }} 19 | shell: bash 20 | run: | 21 | git config --global user.email "me@patrickwu.space" 22 | git config --global user.name "Jinming Wu, Patrick" 23 | git clone --depth 1 https://patrick330602:$GH_TOKEN@github.com/wslutilities/website.git website 24 | bash -x scripts/website-update.bash 25 | git --git-dir=./website/.git --work-tree=./website add -A 26 | git --git-dir=./website/.git --work-tree=./website commit -m "wslpy Wiki update at $(date)" || exit 0 27 | git --git-dir=./website/.git --work-tree=./website push -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | wslpy/__pycache__ 2 | *.pyc 3 | build 4 | dist 5 | *.egg-info 6 | .vscode 7 | .idea 8 | .coverage 9 | htmlcov 10 | .DS_Store 11 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | contact@wslutiliti.es. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | We love pull requests from everyone. By participating in this project, you agree to abide by [Code of Conduct](CODE_OF_CONDUCT.md). 4 | 5 | > Due to the package not reaching beta phase, this document will only provides you with a general ideas of the styles that is using in this project. 6 | 7 | ## System Requirements 8 | 9 | - WSL2 installed, a.k.a., running Windows 10 1903 or higher. 10 | - WSL Distributions that come with Python 3.6+; 11 | 12 | You can use the following as the IDE: 13 | - VS Code; 14 | - PyCharm(Recommended). 15 | 16 | ## Setup environment 17 | 18 | - installl `gi` using the following guide: . 19 | - install `make` from your system and `flake8`, `pdoc`, `nose` and `coverage` from your pip. 20 | 21 | ## Formatting 22 | 23 | - Please use **four spaces** for indentation; 24 | - Use `"""` for function commenting; 25 | - se `#` for general commenting. 26 | 27 | ## Modules to use 28 | - Use `flake8` for linting (`make lint` to lint); 29 | - Use `nose` for testing and `coverage` for code coverage (`make test` to test and generate code test coverage). 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PYTHON := python3 2 | 3 | lint: 4 | $(PYTHON) -m flake8 --exclude tests wslpy/ 5 | 6 | test: 7 | rm -rf htmlcov 8 | nosetests --with-coverage --cover-erase --cover-package=wslpy -w wslpy/ 9 | coverage html 10 | 11 | build: 12 | $(PYTHON) setup.py bdist bdist_wheel 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # wslpy 2 | 3 | [![pypi](https://flat.badgen.net/pypi/v/wslpy)](https://pypi.org/project/wslpy/) 4 | 5 | > `wslpy` is far from complete. the API will change frequently. 6 | 7 | This is a Python3 library for WSL specific tasks, and you can use it to do something amazing: 8 | 9 | ```python 10 | >>> import wslpy as wp 11 | >>> wp.is_wsl() 12 | True 13 | >>> wp.exec.cmd('ver') 14 | Microsoft Windows [Version 10.0.18219.1000] 15 | >>> wp.convert.to('/mnt/c/Windows/') 16 | 'c:\\Windows\\' 17 | >>> 18 | ``` 19 | 20 | ## Installation 21 | 22 | you can install from pypi using `pip install wslpy`, or install from source using `python3 setup.py install` 23 | 24 | ## License 25 | 26 | 27 | 28 | This project uses [GPLv3](LICENSE) License. 29 | -------------------------------------------------------------------------------- /scripts/website-update.bash: -------------------------------------------------------------------------------- 1 | mkdir -p ./website/wslpy/ 2 | wslpy_ver="$(python3 setup.py --version)" 3 | if [ ! -d "./website/wslpy/${wslpy_ver}" ] ; then 4 | mkdir ./website/wslpy/${wslpy_ver} 5 | rm -f ./website/wslpy/current 6 | ln -s ./${wslpy_ver} ./website/wslpy/current 7 | rm -f website/wslpy/dir.txt 8 | echo "" >> website/wslpy/dir.txt 9 | for f in $(ls -d website/wslpy/*/); do 10 | f="$(echo ${f} | sed -e 's\website/\\')" 11 | s_f="$(echo ${f} | sed -e 's\wslpy/\\' -e 's|/||')" 12 | echo -e "\r" >> website/wslpy/dir.txt 13 | done 14 | fi 15 | cp -rf ./html/wslpy/* ./website/wslpy/${wslpy_ver} 16 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | with open("README.md", "r") as fh: 4 | long_description = fh.read() 5 | 6 | setup( 7 | name='wslpy', 8 | version='0.1.0', 9 | description='Python Library for WSL specific tasks', 10 | long_description=long_description, 11 | long_description_content_type="text/markdown", 12 | license='GPLv3', 13 | packages=['wslpy','wslpy/__core__'], 14 | install_requires=['netifaces'], 15 | author='Patrick Wu', 16 | author_email='me@patrickwu.space', 17 | keywords=['system', 'WSL', 'Windows 10', 'Windows 11'], 18 | url='https://github.com/wslutilities/wslpy', 19 | classifiers=[ 20 | "Environment :: Console", 21 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 22 | "Operating System :: POSIX :: Linux", 23 | "Programming Language :: Python :: 3 :: Only" 24 | ] 25 | ) 26 | -------------------------------------------------------------------------------- /wslpy/__core__/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wslutilities/wslpy/c66e09234ddbf2bd22ea01c927baa21f6b7a3b88/wslpy/__core__/__init__.py -------------------------------------------------------------------------------- /wslpy/__core__/access.py: -------------------------------------------------------------------------------- 1 | from os import getcwd, environ 2 | import subprocess 3 | 4 | 5 | def __exec_command__(cmd, *, working_dir=None): 6 | """ 7 | Execute a command in the shell and return the output. 8 | 9 | Parameters 10 | ---------- 11 | cmd : str 12 | The command to be executed 13 | 14 | Returns 15 | ------- 16 | The output of the command as a string 17 | 18 | Raises 19 | ------ 20 | Returns the error from the command 21 | """ 22 | if working_dir is None: 23 | working_dir = getcwd() 24 | try: 25 | cp = subprocess.run(cmd, stdout=subprocess.PIPE, 26 | stderr=subprocess.PIPE, 27 | cwd=working_dir) 28 | if isinstance(cp.stdout, bytes): 29 | cp.stdout = cp.stdout.decode('utf-8') 30 | if isinstance(cp.stderr, bytes): 31 | cp.stderr = cp.stderr.decode('utf-8') 32 | except subprocess.CalledProcessError as e: 33 | raise Exception("command exec failed: ", e.stderr) 34 | else: 35 | return cp 36 | 37 | 38 | def registry(input, key): 39 | """ 40 | Given a valid registry path, retrieves the value of an entry in the 41 | registry. 42 | 43 | Parameters 44 | ---------- 45 | input : str 46 | string of a shell environment variable key. 47 | 48 | key : str 49 | the name of the registry's key in string 50 | 51 | Returns 52 | ------- 53 | The corresponding value as a string 54 | 55 | Raises 56 | ------ 57 | Returns the error from Reg.exe 58 | """ 59 | cmd = ["reg.exe", "query", input, "/v", key] 60 | p = __exec_command__(cmd) 61 | if p.returncode != 0: 62 | raise RuntimeError("The following error propagated from Registry: {}" 63 | .format(p.stderr)) 64 | 65 | query = p.stdout.rstrip() 66 | import re 67 | query = re.sub(r"^\r\n.+\r\n", "", query).lstrip() 68 | query = re.sub(key, "", query).lstrip() 69 | query = re.sub(r"REG_(SZ|MULTI_SZ|EXPAND_SZ|DWORD|BINARY|NONE)", 70 | "", query).lstrip() 71 | return query 72 | 73 | 74 | def distro_info(distro_name=None): 75 | """ 76 | Returns the distro information as a string. 77 | 78 | Returns 79 | ------- 80 | The distro information as a dictionary. 81 | 82 | Raises 83 | ------ 84 | Returns the error from the command 85 | """ 86 | if distro_name is None: 87 | if environ.get("WSL_DISTRO_NAME"): 88 | distro_name = environ.get("WSL_DISTRO_NAME") 89 | else: 90 | raise RuntimeError("WSL_DISTRO_NAME is not set") 91 | p = __exec_command__(["reg.exe", "query", 92 | "HKCU\\SOFTWARE\\Microsoft\\" 93 | "Windows\\CurrentVersion\\Lxss", 94 | "/s", "/f", "DistributionName"]) 95 | if p.returncode != 0: 96 | raise RuntimeError("failed to retrive distro information: {}" 97 | .format(p.stderr)) 98 | raw_data = p.stdout[2:] 99 | raw_list = raw_data.split("\r\n\r\n")[:-1] 100 | for raw_item in raw_list: 101 | if raw_item.endswith(distro_name): 102 | distro_loc = raw_item.split("\r\n")[0] 103 | p2 = __exec_command__(["reg.exe", "query", distro_loc, "/s"]) 104 | if p2.returncode != 0: 105 | raise RuntimeError("failed to retrieve distro information: {}" 106 | .format(p2.stderr)) 107 | import re 108 | raw_distro_info = p2.stdout 109 | # Clean output first to toutput 110 | out = re.sub((r"\r\nHKEY_CURRENT_USER.*\r\n"), '', raw_distro_info) 111 | # split toutput into list with aoutput 112 | out_p = (re.split(r'\s\s+', out))[1:][:-1] 113 | # convert aoutput to dictionary 114 | output = {item: {'type': type, 'value': value} 115 | for item, type, value in zip(out_p[::3], out_p[1::3], 116 | out_p[2::3])} 117 | return output 118 | -------------------------------------------------------------------------------- /wslpy/__core__/check.py: -------------------------------------------------------------------------------- 1 | from os import path, listdir 2 | 3 | from .access import distro_info 4 | 5 | 6 | def is_wsl(): 7 | """ 8 | Check whether the system is WSL. 9 | 10 | Returns 11 | ------- 12 | A boolean value, `True` if it is WSL. 13 | """ 14 | return path.exists('/proc/sys/fs/binfmt_misc/WSLInterop') 15 | 16 | 17 | def is_interop_enabled(): 18 | """ 19 | Checks if interoperability is enabled. 20 | 21 | Returns 22 | ------- 23 | A boolean value, `True` if interoperability is enabled. 24 | """ 25 | if is_wsl(): 26 | if path.exists("/etc/wsl.conf"): 27 | from configparser import ConfigParser 28 | c = ConfigParser() 29 | c.read("/etc/wsl.conf") 30 | if c.has_option('interop', 'enabled'): 31 | value = c['interop']['enabled'] 32 | return value.lower() == 'true' 33 | with open('/proc/sys/fs/binfmt_misc/WSLInterop', 'r') as f: 34 | interop_str = f.read() 35 | value = interop_str.split('\n')[0] 36 | return value == 'enabled' 37 | 38 | 39 | def __read_attribute__(file, attr): 40 | """ 41 | INTERNAL FUNCTION 42 | Tries to find value after the given attribute. 43 | 44 | Returns 45 | ------- 46 | Value of the given attr if found 47 | Else raises Exception('No such attribute found'). 48 | """ 49 | with open(file, mode='r') as f: 50 | lines = f.readlines() 51 | for line in lines: 52 | if line.find(attr) != -1: 53 | line = line.strip() # Strip whitespaces 54 | line = line.replace(attr, "") 55 | line = line.strip('\"') # strip ".." 56 | return line 57 | break 58 | raise Exception('No such attribute found') 59 | 60 | 61 | def detect_distro(): 62 | """ 63 | Reads the /etc/os-release file nad tries to infer 64 | the OS form available attributes. 65 | 66 | Returns 67 | ------- 68 | Name of distribution. 69 | """ 70 | file = '/etc/os-release' 71 | distro = __read_attribute__(file, 'NAME=') 72 | if distro == 'Arch': 73 | return 'archlinux' 74 | elif distro == 'Scientific': 75 | return 'scilinux' 76 | elif distro == 'Fedora Remix for WSL': 77 | return 'fedoraremix' 78 | elif distro == 'Generic': 79 | os_id = __read_attribute__(file, 'ID_LIKE=') 80 | if os_id == 'fedora': 81 | return 'oldfedora' 82 | else: 83 | return 'unknown' 84 | 85 | return distro.lower() 86 | 87 | 88 | def get_mount_prefix(): 89 | """ 90 | This function returns the prefix for the current windows mount location, 91 | aka the Interop Prefix. 92 | 93 | Returns 94 | ------- 95 | The interop prefix. default is ``/mnt/``. 96 | """ 97 | from configparser import ConfigParser 98 | 99 | win_location = '/mnt/' 100 | if path.exists('/etc/wsl.conf'): 101 | config = ConfigParser() 102 | config.read('/etc/wsl.conf') 103 | if config.has_option('automount', 'root'): 104 | win_location = config.get('automount', 'root') 105 | 106 | return win_location 107 | 108 | 109 | def get_sys_drive_prefix(): 110 | """ 111 | This function returns the prefix for the current windows mount locaution, 112 | aka the Sys Drive Prefix. 113 | 114 | Returns 115 | ------- 116 | The sys drive prefix. default is ``/mnt/c``. 117 | """ 118 | ip = get_mount_prefix() 119 | sys_drive = 'c' 120 | drive_list = listdir(ip) 121 | drive_list = [a for a in drive_list if len(a) == 1] 122 | for drive in drive_list: 123 | sys32_path = path.join(ip, drive, 'Windows', 'System32') 124 | if path.exists(sys32_path): 125 | sys_drive = drive 126 | break 127 | return path.join(ip, sys_drive) 128 | 129 | 130 | def wsl_version(): 131 | """ 132 | This function returns the version of WSL. 133 | 134 | Returns 135 | ------- 136 | The version of WSL. 137 | """ 138 | if is_interop_enabled(): 139 | info = distro_info() 140 | flag = int(info['Flags']['value'], 0) 141 | if flag // 8 == 1: 142 | return 2 143 | else: 144 | return 1 145 | else: 146 | import re 147 | from platform import release 148 | rel = release() 149 | if re.match(r'^4\.\d\.\d-\d{5}-Microsoft', rel) is not None: 150 | return 1 151 | else: 152 | return 2 153 | -------------------------------------------------------------------------------- /wslpy/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | ## Documentation for Ver. 0.1.0 3 | 4 | > `wslpy` is far from complete. the API will change frequently. 5 | 6 | This is a Python3 library for WSL specific tasks, 7 | and you can use it to do something amazing: 8 | 9 | ```python 10 | >>> import wslpy as wp 11 | >>> wp.is_wsl() 12 | True 13 | >>> wp.exec.cmd('ver') 14 | Microsoft Windows [Version 10.0.18219.1000] 15 | >>> wp.convert.to('/mnt/c/Windows/') 16 | 'c:\\Windows\\' 17 | >>> 18 | ``` 19 | 20 | ## Installation 21 | 22 | you can install from pypi using `pip install wslpy`, 23 | or install from source using `python3 setup.py install` 24 | 25 | ## License 26 | 27 | 28 | 29 | This project uses [GPLv3](LICENSE) License. 30 | 31 | """ 32 | from .__core__.check import is_interop_enabled, is_wsl 33 | 34 | __pdoc__ = {} 35 | __pdoc__["tests"] = False 36 | 37 | __all__ = [ 38 | "is_interop_enabled", 39 | "is_wsl", 40 | ] 41 | -------------------------------------------------------------------------------- /wslpy/__internal__.py: -------------------------------------------------------------------------------- 1 | """ 2 | This is the class that helps with wslu; 3 | it is okay to use with other programs but it is not warranted 4 | """ 5 | import gi 6 | 7 | gi.require_version('Gtk', '3.0') 8 | from gi.repository import Gtk # noqa: E402 9 | 10 | 11 | def find_icon(icon_name): 12 | """ 13 | Find icon from a input string. 14 | 15 | Returns 16 | ------- 17 | A path to the icon file, an empty string if not found. 18 | """ 19 | icon_theme = Gtk.IconTheme.get_default() 20 | found_icon = "" 21 | for res in range(0, 512, 2): 22 | icon = icon_theme.lookup_icon(icon_name, res, 0) 23 | if icon: 24 | found_icon = icon.get_filename() 25 | return found_icon if found_icon else "" 26 | -------------------------------------------------------------------------------- /wslpy/convert.py: -------------------------------------------------------------------------------- 1 | """ 2 | This is the class that helps convert between 3 | 3 types of path used widely in WSL. 4 | """ 5 | import re 6 | from enum import Enum 7 | from .__core__.check import get_mount_prefix 8 | 9 | 10 | class PathType(Enum): 11 | """Types for Path Conversions 12 | 13 | `AUTO` 14 | Automatic Conversion 15 | 16 | `LINUX` 17 | Convert to Linux Path 18 | 19 | `WIN` 20 | Convert to Windows Path 21 | 22 | `WIN_DOUBLE` 23 | Convert to Windows Path with Double Dash 24 | """ 25 | AUTO = 0 26 | LINUX = 1 27 | WIN = 2 28 | WIN_DOUBLE = 3 29 | 30 | 31 | def __post_mount_prefix__(): 32 | a = get_mount_prefix() 33 | a = re.sub(r"^\/", r"", a) 34 | a = re.sub(r"\/$", r"", a) 35 | return a 36 | 37 | 38 | MOUNT_PREFIX = __post_mount_prefix__() 39 | 40 | 41 | def __lin2win__(path, is_ns_modern=False): 42 | if re.match(r'^/{}'.format(MOUNT_PREFIX), path) is not None: 43 | # replace / to \ 44 | path = re.sub(r'/', r'\\', path) 45 | converted_mount = re.sub(r'/', r'\\', MOUNT_PREFIX) 46 | # replace \\ to : 47 | path = re.sub(r'\\{}\\([A-Za-z])'.format(converted_mount), 48 | r'\1:', path) 49 | else: 50 | from os import environ 51 | if not environ.get('WSL_DISTRO_NAME'): 52 | raise Exception( 53 | "WSL_DISTRO_NAME env not found. unable to convert.") 54 | # remove trailing / 55 | path = re.sub(r'^/', r'', path) 56 | # replace / to \ 57 | path = re.sub(r'/', r'\\', path) 58 | # replace // to : 59 | type_name = "wsl$" 60 | if is_ns_modern: 61 | type_name = "wsl.localhost" 62 | path = "\\\\{}\\{}\\{}".format(type_name, 63 | environ.get('WSL_DISTRO_NAME'), 64 | path) 65 | return path 66 | 67 | 68 | def __win2dwin__(path): 69 | # replace \ to \\ 70 | return re.sub(r'\\', r'\\\\', path) 71 | 72 | 73 | def __dwin2lin__(path): 74 | # replace \\ to / 75 | path = re.sub(r'\\\\', r'/', path) 76 | # replace : to // 77 | path = re.sub(r'([A-Za-z]):', r'/{}/\1'.format(MOUNT_PREFIX), path) 78 | return path 79 | 80 | 81 | def to(input, to_type=PathType.AUTO, is_ns_modern=False): 82 | """ 83 | Convert between 3 types of path used widely in WSL. 84 | 85 | Parameters 86 | ---------- 87 | input : str 88 | the string of the original path. 89 | to_type : PathType 90 | the type user wants to convert to. Default is PathType.AUTO. 91 | is_ns_modern : bool 92 | if the linux path needs to convert to new style(``wsl.localhost``). 93 | Default is False (``wsl$``). 94 | 95 | Returns 96 | ------- 97 | string of converted path. 98 | 99 | Raises 100 | ------ 101 | ValueError 102 | An error occurred when the input is invalid. 103 | """ 104 | # Windows Path /w Double Dash-line 105 | if re.match(r'^[A-Za-z]:\\\\', input) is not None: 106 | if to_type in (PathType.AUTO, PathType.LINUX): 107 | return __dwin2lin__(input) 108 | elif to_type == PathType.WIN: 109 | return __lin2win__(__dwin2lin__(input), is_ns_modern) 110 | elif to_type == PathType.WIN_DOUBLE: 111 | return input 112 | else: 113 | raise ValueError("ERROR: Invalid Conversion Type "+to_type) 114 | elif re.match(r'^[A-Za-z]:', input) is not None: # Windows Path 115 | if to_type in (PathType.AUTO, PathType.LINUX): 116 | return __dwin2lin__(__win2dwin__(input)) 117 | elif to_type == PathType.WIN: 118 | return input 119 | elif to_type == PathType.WIN_DOUBLE: 120 | return __win2dwin__(input) 121 | else: 122 | raise ValueError("ERROR: Invalid Conversion Type "+to_type) 123 | elif re.match(r'^\\\\wsl', input) is not None: # WSL Windows Path 124 | # \\wsl$\\\\ is the original style path; 125 | # \\wsl\\\\ is the new style path but deprecated; 126 | # \\wsl.localhost\\\\ is the current new style path. 127 | input = re.sub(r'^\\\\(wsl|wsl\$|wsl\.localhost)\\[^\\]*\\', 128 | r'\\', input) 129 | input = re.sub(r'\\', r'/', input) 130 | if to_type in (PathType.AUTO, PathType.LINUX): 131 | return input 132 | elif to_type == PathType.WIN: 133 | return __lin2win__(input, is_ns_modern) 134 | elif to_type == PathType.WIN_DOUBLE: 135 | return __win2dwin__(__lin2win__(input, is_ns_modern)) 136 | else: 137 | raise ValueError("ERROR: Invalid Conversion Type "+to_type) 138 | # Linux Path 139 | else: 140 | if to_type in (PathType.AUTO, PathType.WIN): 141 | return __lin2win__(input) 142 | elif to_type == PathType.LINUX: 143 | return input 144 | elif to_type == PathType.WIN_DOUBLE: 145 | return __win2dwin__(__lin2win__(input, is_ns_modern)) 146 | else: 147 | raise ValueError("ERROR: Invalid Conversion Type "+to_type) 148 | 149 | 150 | def to_win(input): 151 | """ 152 | Convert path to Windows style. 153 | 154 | Parameters 155 | ---------- 156 | input : str 157 | the string of the original path. 158 | 159 | Returns 160 | ------- 161 | string of Windows Style path. 162 | 163 | Raises 164 | ------ 165 | ValueError 166 | An error occurred when the input is invalid. 167 | """ 168 | return to(input, PathType.WIN) 169 | 170 | 171 | def to_win_double(input): 172 | """ 173 | Convert path to Windows Path /w Double style. 174 | 175 | Parameters 176 | ---------- 177 | input : str 178 | the string of the original path. 179 | 180 | Returns 181 | ------- 182 | string of Windows Path /w Double Style path. 183 | 184 | Raises 185 | ------ 186 | ValueError 187 | An error occurred when the input is invalid. 188 | """ 189 | return to(input, PathType.WIN_DOUBLE) 190 | 191 | 192 | def to_wsl(input): 193 | """ 194 | Convert path to Linux style. 195 | 196 | Parameters 197 | ---------- 198 | input : str 199 | the string of the original path. 200 | 201 | Returns 202 | ------- 203 | string of Linux Style path. 204 | 205 | Raises 206 | ------ 207 | ValueError 208 | An error occurred when the input is invalid. 209 | """ 210 | return to(input, PathType.LINUX) 211 | -------------------------------------------------------------------------------- /wslpy/exec.py: -------------------------------------------------------------------------------- 1 | """ 2 | This is the execution class to execute commands 3 | from different windows executables 4 | """ 5 | from os import path 6 | from .__core__.check import get_sys_drive_prefix, is_interop_enabled, is_wsl 7 | from .__core__.access import __exec_command__ 8 | 9 | 10 | def __pre_check__(): 11 | assert is_wsl(), "This is not a wsl distribution" 12 | assert is_interop_enabled(), ( 13 | "WSL Interoperability is disabled and WSL Utilities won't work. " 14 | "Please enable it by:\n" 15 | "1. open /etc/wsl.conf using root or equivalent editing permission;\n" 16 | "2. under [interop] section, set enabled to true;\n" 17 | "3. restart your distribution.\n\nOr, \n" 18 | "# echo 1 > /proc/sys/fs/binfmt_misc/WSLInterop") 19 | 20 | 21 | def cmd(command, working_dir=None): 22 | """ 23 | Execute cmd command. 24 | 25 | Parameters 26 | ---------- 27 | command : str 28 | string of `cmd.exe` commands. 29 | working_dir : str 30 | working directory of the command. default is None. 31 | 32 | Returns 33 | ------- 34 | return a CompletedProcess object. 35 | """ 36 | __pre_check__() 37 | sysdrv_prefix = get_sys_drive_prefix() 38 | pt = path.join(sysdrv_prefix, "Windows", "System32", "cmd.exe") 39 | cmd = [pt, "/c", command] 40 | p = __exec_command__(cmd, working_dir=working_dir) 41 | return p 42 | 43 | 44 | def winps(command, working_dir=None): 45 | """ 46 | Execute Windows PowerShell(5.*) command. 47 | 48 | Parameter 49 | --------- 50 | command : str 51 | string of `powershell.exe` command. 52 | working_dir : str 53 | working directory of the command. default is None. 54 | 55 | Returns 56 | ------- 57 | return a CompletedProcess object. 58 | """ 59 | __pre_check__() 60 | sysdrv_prefix = get_sys_drive_prefix() 61 | pt = path.join(sysdrv_prefix, "Windows", "System32", 62 | "WindowsPowerShell", "v1.0", "powershell.exe") 63 | cmd = [pt, "-NoProfile", "-NonInteractive", "-Command", 64 | command] 65 | p = __exec_command__(cmd, working_dir=working_dir) 66 | return p 67 | -------------------------------------------------------------------------------- /wslpy/helper.py: -------------------------------------------------------------------------------- 1 | """ 2 | This provides a pre-configured set of tools to use 3 | directly in WSL. 4 | """ 5 | import os 6 | import re 7 | import logging 8 | 9 | from .exec import winps 10 | from .__core__.check import get_mount_prefix, get_sys_drive_prefix 11 | from .__core__.access import __exec_command__ 12 | 13 | 14 | def automount_drive(option=None, logging_level=logging.INFO): 15 | """ 16 | This allows the automounting all other drives that will 17 | not automount using the defualt automount function. 18 | 19 | Parameters 20 | ---------- 21 | option : str 22 | the options that will be used in the mount location. 23 | By default it will use the system defualt or your 24 | option in `wsl.conf`. 25 | logging_level : int 26 | the logging level that will be used. default is `logging.INFO`. 27 | """ 28 | logging.basicConfig(level=logging_level) 29 | mntpnt_prefix = get_mount_prefix() 30 | sysdrv_prefix = get_sys_drive_prefix() 31 | logging.debug("mount prefix: {} systemdrive prefix: {}" 32 | .format(mntpnt_prefix, sysdrv_prefix)) 33 | fsutil_path = os.path.join(sysdrv_prefix, "Windows", 34 | "system32", "fsutil.exe") 35 | drv_p = __exec_command__([fsutil_path, "fsinfo", "drives"]) 36 | if drv_p.returncode: 37 | err_str = "retrive Windows file system info failed: {}" \ 38 | .format(drv_p.stderr) 39 | logging.error(err_str) 40 | raise Exception(err_str) 41 | drv_list = drv_p.stdout.replace("\r\n", "") \ 42 | .replace(":", "") \ 43 | .replace("Drives ", "") \ 44 | .replace("\\", "") \ 45 | .lower().split() 46 | logging.debug("drive list: {}".format(str(drv_list))) 47 | 48 | if os.path.isfile("/etc/wsl.conf"): 49 | logging.debug("wsl.conf exists, checking it out") 50 | from configparser import ConfigParser 51 | c = ConfigParser() 52 | c.read("/etc/wsl.conf") 53 | if c.has_option("automount", "options"): 54 | option = c["automount"]["options"] 55 | logging.debug("got wsl.conf option: {}".format(option)) 56 | 57 | if option is not None: 58 | # from subiquity.system_setup.ui.views.wslconfbase 59 | # code written by me under AGPLv3 License 60 | # filesystem independent mount option 61 | fsimo = [r"async", r"(no)?atime", r"(no)?auto", 62 | r"(fs|def|root)?context=\w+", r"(no)?dev", r"(no)?diratime", 63 | r"dirsync", r"(no)?exec", r"group", r"(no)?iversion", 64 | r"(no)?mand", r"_netdev", r"nofail", r"(no)?relatime", 65 | r"(no)?strictatime", r"(no)?suid", r"owner", r"remount", 66 | r"ro", r"rw", r"_rnetdev", r"sync", r"(no)?user", r"users"] 67 | # DrvFs filesystem mount option 68 | drvfsmo = r"case=(dir|force|off)|metadata|(u|g)id=\d+|(u|f|d)mask=\d+|" 69 | fso = "{0}{1}".format(drvfsmo, '|'.join(fsimo)) 70 | 71 | if option != "": 72 | e_t = "" 73 | p = option.split(',') 74 | x = True 75 | for i in p: 76 | if i == "": 77 | e_t += "an empty entry detected; " 78 | x = x and False 79 | elif re.fullmatch(fso, i) is not None: 80 | x = x and True 81 | else: 82 | e_t += "{} is not a valid mount option; ".format(i) 83 | x = x and False 84 | if not x: 85 | raise Exception("Invalid Input: {}Please check " 86 | "https://docs.microsoft.com/en-us/windows/wsl/" 87 | "wsl-config#mount-options " 88 | "for correct valid input".format(e_t)) 89 | for drv in drv_list: 90 | logging.debug("visiting drive %s" % drv) 91 | drv_path = os.path.join(mntpnt_prefix, drv) 92 | os.makedirs(drv_path, exist_ok=True) 93 | if not os.listdir(drv_path): 94 | mount_p = __exec_command__(["mount", "-t", "drvfs", 95 | "{}:".format(drv.upper()), 96 | drv_path, "-o", option]) 97 | if mount_p.returncode: 98 | logging.debug("failed to mount but still continue") 99 | continue 100 | 101 | 102 | def time_reset(): 103 | """ 104 | This will reset your WSL2 time to the correct Windows time. 105 | requires root access. 106 | """ 107 | command = 'Get-Date -UFormat "%m/%d/%Y %T %Z"' 108 | p = winps(command) 109 | if p.returncode: 110 | raise Exception("failed to get time from Windows") 111 | time = p.stdout.rstrip() 112 | sp = __exec_command__(["date", "-s", time]) 113 | if sp.returncode: 114 | raise Exception("failed to set time") 115 | -------------------------------------------------------------------------------- /wslpy/system.py: -------------------------------------------------------------------------------- 1 | """ 2 | Provides users with the access for Windows system 3 | information like system vatiables and registry keys. 4 | """ 5 | import re 6 | from .__core__.access import __exec_command__ 7 | from wslpy.exec import winps 8 | from .__core__.check import wsl_version, detect_distro 9 | 10 | 11 | def list_shellenv(): 12 | """ 13 | List avaiable shell environment variables to use and 14 | its corresponding path. 15 | 16 | Returns 17 | ------- 18 | A Dictionary of registry keys and its corresbonding values. 19 | """ 20 | cmd = ["reg.exe", "query", "HKCU\\Software\\Microsoft\\Windows" 21 | "\\CurrentVersion\\Explorer\\User Shell Folders", "/s"] 22 | p = __exec_command__(cmd) 23 | if p.returncode != 0: 24 | raise RuntimeError("Failed to get shell environment variables: ", 25 | p.stderr) 26 | routput = p.stdout 27 | # Clean output first to toutput 28 | toutput = re.sub((r"\r\nHKEY_CURRENT_USER\\Software\\Microsoft\\" 29 | r"Windows\\CurrentVersion\\Explorer\\User Shell" 30 | r" Folders\r\n"), '', routput) 31 | toutput = re.sub(r'(REG_EXPAND_SZ|\r|\n)', '', toutput) 32 | toutput = re.sub(r'(REG_SZ|\r|\n)', '', toutput) 33 | # split toutput into list with aoutput 34 | aoutput = (re.split(r'\s\s+', toutput))[1:] 35 | # convert aoutput to dictionary 36 | output = dict(zip(aoutput[::2], aoutput[1::2])) 37 | return output 38 | 39 | 40 | def get_shellenv(input): 41 | """ 42 | Get the value from shell environment variable. 43 | 44 | Parameters 45 | ---------- 46 | input : str 47 | string of a shell environment variable key. 48 | 49 | Returns 50 | ------- 51 | A string of the corresbonding value from the input. 52 | 53 | Raises 54 | ------ 55 | KeyError 56 | An error occured when you input a empty value or the registry key 57 | cannot be found in registry. 58 | """ 59 | try: 60 | shl_list = list_shellenv() 61 | if input in shl_list.keys(): 62 | return shl_list[input] 63 | else: 64 | raise KeyError("Key does not exist.") 65 | except KeyError as err: 66 | print(err) 67 | 68 | 69 | def list_sysenv(): 70 | """ 71 | List available system environment variables to use and 72 | its corresponding path. 73 | 74 | Returns 75 | ------- 76 | A Dictionary of system environment variables keys and its corresponding 77 | values. 78 | """ 79 | p = winps("Get-ChildItem env:") 80 | if p.returncode != 0: 81 | raise RuntimeError("Failed to get system environment variables: ", 82 | p.stderr) 83 | routput = p.stdout 84 | toutput = re.sub(r'(Name|Value|----|-|-----|\r|\n)', 85 | '', routput) 86 | aoutput = (re.split(r'\s\s+', toutput))[1:] 87 | # convert aoutput to dictionary 88 | output = dict(zip(aoutput[::2], aoutput[1::2])) 89 | return output 90 | 91 | 92 | def get_sysenv(input): 93 | """ 94 | Get the value from shell environment variable. 95 | 96 | Parameters 97 | ---------- 98 | input : str 99 | string of a shell environment variable key. 100 | 101 | Returns 102 | ------- 103 | A string of the corresbonding value from the input. 104 | 105 | Raises 106 | ------ 107 | KeyError 108 | An error occured when you input a empty value or the registry key 109 | cannot be found in registry. 110 | """ 111 | try: 112 | sys_var_list = list_sysenv() 113 | if input in sys_var_list.keys(): 114 | return sys_var_list[input] 115 | else: 116 | raise KeyError("Key does not exist.") 117 | except KeyError as err: 118 | print(err) 119 | 120 | 121 | def get_ip(): 122 | """ 123 | Get the current IPv4 address from your WSL2 instance 124 | 125 | Returns 126 | ------- 127 | A string of IPv4 address 128 | """ 129 | import netifaces as ni 130 | return ni.ifaddresses("eth0")[ni.AF_INET][0]['addr'] 131 | 132 | 133 | __all__ = [ 134 | "list_shellenv", 135 | "get_shellenv", 136 | "list_sysenv", 137 | "get_sysenv", 138 | "wsl_version", 139 | "detect_distro", 140 | "get_ip", 141 | ] 142 | -------------------------------------------------------------------------------- /wslpy/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wslutilities/wslpy/c66e09234ddbf2bd22ea01c927baa21f6b7a3b88/wslpy/tests/__init__.py -------------------------------------------------------------------------------- /wslpy/tests/test_convert.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | __author__ = 'Patrick Wu' 3 | from nose.tools import assert_equal, raises 4 | 5 | import unittest 6 | import wslpy.convert as wconvert 7 | 8 | 9 | def setUp(): 10 | pass 11 | 12 | 13 | def teardown(): 14 | pass 15 | 16 | 17 | def test_to_win(): 18 | result=wconvert.to("C:\\test") 19 | assert_equal("/mnt/C/test", result) 20 | 21 | 22 | def test_to_windouble(): 23 | result=wconvert.to("C:\\\\test") 24 | assert_equal("/mnt/C/test", result) 25 | 26 | 27 | def test_to_linux(): 28 | result=wconvert.to("/mnt/c/test") 29 | assert_equal("c:\\test", result) 30 | 31 | 32 | @raises(ValueError) 33 | def test_to_invalid(): 34 | wconvert.to("/mnt/c/test", 'NoneSense') 35 | 36 | 37 | def test_towin_win(): 38 | result=wconvert.to_win("C:\\test") 39 | assert_equal("C:\\test", result) 40 | 41 | 42 | def test_towin_windouble(): 43 | result=wconvert.to_win("C:\\\\test") 44 | assert_equal("C:\\test", result) 45 | 46 | 47 | def test_towin_linux(): 48 | result=wconvert.to_win("/mnt/c/test") 49 | assert_equal("c:\\test", result) 50 | 51 | 52 | def test_towindouble_win(): 53 | result=wconvert.to_win_double("C:\\test") 54 | assert_equal("C:\\\\test", result) 55 | 56 | 57 | def test_towindouble_windouble(): 58 | result=wconvert.to_win_double("C:\\\\test") 59 | assert_equal("C:\\\\test", result) 60 | 61 | 62 | def test_towindouble_linux(): 63 | result=wconvert.to_win_double("/mnt/c/test") 64 | assert_equal("c:\\\\test", result) 65 | 66 | 67 | def test_towsl_win(): 68 | result=wconvert.to_wsl("C:\\test") 69 | assert_equal("/mnt/C/test", result) 70 | 71 | 72 | def test_towsl_windouble(): 73 | result=wconvert.to_wsl("C:\\\\test") 74 | assert_equal("/mnt/C/test", result) 75 | 76 | 77 | def test_towsl_linux(): 78 | result=wconvert.to_wsl("/mnt/c/test") 79 | assert_equal("/mnt/c/test", result) -------------------------------------------------------------------------------- /wslpy/tests/test_internal.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wslutilities/wslpy/c66e09234ddbf2bd22ea01c927baa21f6b7a3b88/wslpy/tests/test_internal.py -------------------------------------------------------------------------------- /wslpy/win.py: -------------------------------------------------------------------------------- 1 | """ 2 | Provides easy access to the Windows information 3 | """ 4 | from .__core__.access import distro_info, registry 5 | from wslpy.exec import winps 6 | 7 | 8 | def get_current_executable(): 9 | """ 10 | Get current exes of the current WSL (for ones that have) 11 | 12 | Returns 13 | ------- 14 | A string of the executables 15 | """ 16 | import os 17 | from wslpy.convert import to_wsl 18 | from wslpy.exec import winps 19 | 20 | _distro_info = distro_info() 21 | if "PackageFamilyName" in _distro_info: 22 | pname = _distro_info["PackageFamilyName"]['value'] 23 | p = winps("[Environment]::GetFolderPath('LocalApplicationData')") 24 | if p.returncode: 25 | raise Exception("Failed to get LocalApplicationData") 26 | raw_win_path = p.stdout.replace("\r\n", "") 27 | win_path = raw_win_path + "\\Microsoft\\WindowsApps\\" + pname 28 | exe_real_loc = to_wsl(win_path) 29 | return os.listdir(exe_real_loc)[0] 30 | else: 31 | return None 32 | 33 | 34 | def get_display_scaling(): 35 | """ 36 | Get Windows Display Scaling 37 | 38 | Returns 39 | ------- 40 | A number of the current display scaling 41 | """ 42 | command = """ 43 | Add-Type @' 44 | using System; 45 | using System.Runtime.InteropServices; 46 | using System.Drawing; 47 | 48 | public class DPI { 49 | [DllImport("gdi32.dll")] 50 | static extern int GetDeviceCaps(IntPtr hdc, int nIndex); 51 | 52 | public enum DeviceCap { 53 | VERTRES = 10, 54 | DESKTOPVERTRES = 117 55 | } 56 | 57 | public static float scaling() { 58 | Graphics g = Graphics.FromHwnd(IntPtr.Zero); 59 | IntPtr desktop = g.GetHdc(); 60 | int LogicalScreenHeight = GetDeviceCaps(desktop, (int)DeviceCap.VERTRES); 61 | int PhysicalScreenHeight = GetDeviceCaps(desktop, 62 | (int)DeviceCap.DESKTOPVERTRES); 63 | 64 | return (float)PhysicalScreenHeight / (float)LogicalScreenHeight; 65 | } 66 | } 67 | '@ -ReferencedAssemblies 'System.Drawing.dll' 68 | 69 | [Math]::round([DPI]::scaling(), 2) * 100 70 | """ 71 | 72 | p = winps(command) 73 | if p.returncode: 74 | raise Exception("Failed to get display scaling: ", p.stderr) 75 | dscale = int(p.stdout.rstrip()) / 100 76 | return dscale 77 | 78 | 79 | def get_windows_locale(): 80 | """ 81 | Get Windows Locale 82 | 83 | Returns 84 | ------- 85 | a string of Windows Locale 86 | """ 87 | p = winps("(Get-Culture).Name") 88 | if p.returncode: 89 | raise Exception("Failed to get Windows Locale: ", p.stderr) 90 | win_locale = p.stdout.rstrip().replace("-", "_") 91 | return win_locale 92 | 93 | 94 | def get_windows_theme(): 95 | """ 96 | Get Windows Theme 97 | 98 | Returns 99 | ------- 100 | a string of either "light" or "dark" 101 | """ 102 | raw_theme = registry("HKCU\\SOFTWARE\\Microsoft\\Windows\\Current" 103 | "Version\\Themes\\Personalize", "AppsUseLightTheme") 104 | return "dark" if int(raw_theme, 0) else "light" 105 | 106 | 107 | def get_windows_install_date(friendly_output=False): 108 | """ 109 | Get the install date of the current installed build of Windows 110 | 111 | Parameters 112 | ---------- 113 | friendly_output: bool 114 | whether the value returned is readable or not, `false` by default 115 | 116 | Returns 117 | ------- 118 | A integer of unix timestamp or a string of readable time 119 | """ 120 | raw_time = registry("HKLM\\Software\\Microsoft" 121 | "\\Windows NT\\CurrentVersion", "InstallDate") 122 | dec_time = int(raw_time, 0) 123 | 124 | if friendly_output: 125 | from datetime import datetime 126 | f_time = \ 127 | datetime.utcfromtimestamp(dec_time).strftime('%Y-%m-%d %H:%M:%S') 128 | return f_time 129 | else: 130 | return dec_time 131 | 132 | 133 | def get_windows_branch(): 134 | """ 135 | Get the current Windows branch 136 | 137 | Returns 138 | ------- 139 | a string of Windows Branch 140 | """ 141 | raw_branch = registry("HKLM\\Software\\Microsoft" 142 | "\\Windows NT\\CurrentVersion", "BuildBranch") 143 | return raw_branch 144 | 145 | 146 | def get_windows_build(is_full_build=False): 147 | """ 148 | Get Windows build information 149 | 150 | Parameters 151 | ---------- 152 | is_full_build: bool 153 | if it should print full build, `False` by default 154 | 155 | Returns 156 | ------- 157 | a string of windows build 158 | """ 159 | if is_full_build: 160 | raw_build = registry("HKLM\\Software\\Microsoft" 161 | "\\Windows NT\\CurrentVersion", 162 | "BuildLabEx") 163 | else: 164 | raw_build = registry("HKLM\\Software\\Microsoft" 165 | "\\Windows NT\\CurrentVersion", 166 | "CurrentBuild") 167 | return raw_build 168 | 169 | 170 | def get_windows_uptime(): 171 | """ 172 | Get the current uptime in Windows 173 | 174 | Returns 175 | ------- 176 | a array in the format of [days, hours, minutes] 177 | """ 178 | p = winps("[int64]((get-date) - (gcim Win32_Operating" 179 | "System).LastBootUpTime).TotalSeconds") 180 | if p.returncode: 181 | return -1 182 | raw_time = int(p.stdout.rstrip()) 183 | raw_days = raw_time // 86400 184 | raw_hours = raw_time // 3600 % 24 185 | raw_minutes = raw_time // 60 % 60 186 | return [raw_days, raw_hours, raw_minutes] 187 | 188 | 189 | __all__ = ["get_current_executable", "get_display_scaling", 190 | "get_windows_locale", "get_windows_theme", 191 | "get_windows_install_date", "get_windows_branch", 192 | "get_windows_build", "get_windows_uptime", 193 | "registry", "distro_info"] 194 | --------------------------------------------------------------------------------