django-handyhelpers 0.3.20__py3-none-any.whl → 0.3.35__py3-none-any.whl

handyhelpers/static/node_modules/find-up/index.d.ts

@@ -0,0 +1,247 @@
+import {type Options as LocatePathOptions} from 'locate-path';
+
+/**
+Return this in a `matcher` function to stop the search and force `findUp` to immediately return `undefined`.
+*/
+export const findUpStop: unique symbol;
+
+export type Match = string | typeof findUpStop | undefined;
+
+export type Options = {
+	/**
+	A directory path where the search halts if no matches are found before reaching this point.
+
+	Default: Root directory
+	*/
+	readonly stopAt?: string;
+} & LocatePathOptions;
+
+/**
+Find a file or directory by walking up parent directories.
+
+@param name - The name of the file or directory to find. Can be multiple.
+@returns The first path found (by respecting the order of `name`s) or `undefined` if none could be found.
+
+@example
+```
+// /
+// └── Users
+//     └── sindresorhus
+//         ├── unicorn.png
+//         └── foo
+//             └── bar
+//                 ├── baz
+//                 └── example.js
+
+// example.js
+import {findUp} from 'find-up';
+
+console.log(await findUp('unicorn.png'));
+//=> '/Users/sindresorhus/unicorn.png'
+
+console.log(await findUp(['rainbow.png', 'unicorn.png']));
+//=> '/Users/sindresorhus/unicorn.png'
+```
+*/
+export function findUp(name: string | readonly string[], options?: Options): Promise<string | undefined>;
+
+/**
+Find a file or directory by walking up parent directories.
+
+@param matcher - Called for each directory in the search. Return a path or `findUpStop` to stop the search.
+@returns The first path found or `undefined` if none could be found.
+
+@example
+```
+import path from 'node:path';
+import {findUp, pathExists} from 'find-up';
+
+console.log(await findUp(async directory => {
+	const hasUnicorns = await pathExists(path.join(directory, 'unicorn.png'));
+	return hasUnicorns && directory;
+}, {type: 'directory'}));
+//=> '/Users/sindresorhus'
+```
+*/
+export function findUp(matcher: (directory: string) => (Match | Promise<Match>), options?: Options): Promise<string | undefined>;
+
+/**
+Synchronously find a file or directory by walking up parent directories.
+
+@param name - The name of the file or directory to find. Can be multiple.
+@returns The first path found (by respecting the order of `name`s) or `undefined` if none could be found.
+
+@example
+```
+// /
+// └── Users
+//     └── sindresorhus
+//         ├── unicorn.png
+//         └── foo
+//             └── bar
+//                 ├── baz
+//                 └── example.js
+
+// example.js
+import {findUpSync} from 'find-up';
+
+console.log(findUpSync('unicorn.png'));
+//=> '/Users/sindresorhus/unicorn.png'
+
+console.log(findUpSync(['rainbow.png', 'unicorn.png']));
+//=> '/Users/sindresorhus/unicorn.png'
+```
+*/
+export function findUpSync(name: string | readonly string[], options?: Options): string | undefined;
+
+/**
+Synchronously find a file or directory by walking up parent directories.
+
+@param matcher - Called for each directory in the search. Return a path or `findUpStop` to stop the search.
+@returns The first path found or `undefined` if none could be found.
+
+@example
+```
+import path from 'node:path';
+import {findUpSync, pathExistsSync} from 'find-up';
+
+console.log(findUpSync(directory => {
+	const hasUnicorns = pathExistsSync(path.join(directory, 'unicorn.png'));
+	return hasUnicorns && directory;
+}, {type: 'directory'}));
+//=> '/Users/sindresorhus'
+```
+*/
+export function findUpSync(matcher: (directory: string) => Match, options?: Options): string | undefined;
+
+/**
+Find files or directories by walking up parent directories.
+
+@param name - The name of the file or directory to find. Can be multiple.
+@returns All paths found (by respecting the order of `name`s) or an empty array if none could be found.
+
+@example
+```
+// /
+// └── Users
+//     └── sindresorhus
+//         ├── unicorn.png
+//         └── foo
+//             ├── unicorn.png
+//             └── bar
+//                 ├── baz
+//                 └── example.js
+
+// example.js
+import {findUpMultiple} from 'find-up';
+
+console.log(await findUpMultiple('unicorn.png'));
+//=> ['/Users/sindresorhus/foo/unicorn.png', '/Users/sindresorhus/unicorn.png']
+
+console.log(await findUpMultiple(['rainbow.png', 'unicorn.png']));
+//=> ['/Users/sindresorhus/foo/unicorn.png', '/Users/sindresorhus/unicorn.png']
+```
+*/
+export function findUpMultiple(name: string | readonly string[], options?: Options): Promise<string[]>;
+
+/**
+Find files or directories by walking up parent directories.
+
+@param matcher - Called for each directory in the search. Return a path or `findUpStop` to stop the search.
+@returns All paths found or an empty array if none could be found.
+
+@example
+```
+import path from 'node:path';
+import {findUpMultiple, pathExists} from 'find-up';
+
+console.log(await findUpMultiple(async directory => {
+	const hasUnicorns = await pathExists(path.join(directory, 'unicorn.png'));
+	return hasUnicorns && directory;
+}, {type: 'directory'}));
+//=> ['/Users/sindresorhus/foo', '/Users/sindresorhus']
+```
+*/
+export function findUpMultiple(matcher: (directory: string) => (Match | Promise<Match>), options?: Options): Promise<string[]>;
+
+/**
+Synchronously find files or directories by walking up parent directories.
+
+@param name - The name of the file or directory to find. Can be multiple.
+@returns All paths found (by respecting the order of `name`s) or an empty array if none could be found.
+
+@example
+```
+// /
+// └── Users
+//     └── sindresorhus
+//         ├── unicorn.png
+//         └── foo
+//             ├── unicorn.png
+//             └── bar
+//                 ├── baz
+//                 └── example.js
+
+// example.js
+import {findUpMultipleSync} from 'find-up';
+
+console.log(findUpMultipleSync('unicorn.png'));
+//=> ['/Users/sindresorhus/foo/unicorn.png', '/Users/sindresorhus/unicorn.png']
+
+console.log(findUpMultipleSync(['rainbow.png', 'unicorn.png']));
+//=> ['/Users/sindresorhus/foo/unicorn.png', '/Users/sindresorhus/unicorn.png']
+```
+*/
+export function findUpMultipleSync(name: string | readonly string[], options?: Options): string[];
+
+/**
+Synchronously find files or directories by walking up parent directories.
+
+@param matcher - Called for each directory in the search. Return a path or `findUpStop` to stop the search.
+@returns All paths found or an empty array if none could be found.
+
+@example
+```
+import path from 'node:path';
+import {findUpMultipleSync, pathExistsSync} from 'find-up';
+
+console.log(findUpMultipleSync(directory => {
+	const hasUnicorns = pathExistsSync(path.join(directory, 'unicorn.png'));
+	return hasUnicorns && directory;
+}, {type: 'directory'}));
+//=> ['/Users/sindresorhus/foo', '/Users/sindresorhus']
+```
+*/
+export function findUpMultipleSync(matcher: (directory: string) => Match, options?: Options): string[];
+
+/**
+Check if a path exists.
+
+@param path - The path to a file or directory.
+@returns Whether the path exists.
+
+@example
+```
+import {pathExists} from 'find-up';
+
+console.log(await pathExists('/Users/sindresorhus/unicorn.png'));
+//=> true
+```
+*/
+export function pathExists(path: string): Promise<boolean>;
+
+/**
+Synchronously check if a path exists.
+
+@param path - Path to the file or directory.
+@returns Whether the path exists.
+
+@example
+```
+import {pathExistsSync} from 'find-up';
+
+console.log(pathExistsSync('/Users/sindresorhus/unicorn.png'));
+//=> true
+```
+*/
+export function pathExistsSync(path: string): boolean;

handyhelpers/static/node_modules/find-up/index.js

@@ -0,0 +1,107 @@
+import path from 'node:path';
+import {locatePath, locatePathSync} from 'locate-path';
+import {toPath} from 'unicorn-magic';
+
+export const findUpStop = Symbol('findUpStop');
+
+export async function findUpMultiple(name, options = {}) {
+	let directory = path.resolve(toPath(options.cwd) ?? '');
+	const {root} = path.parse(directory);
+	const stopAt = path.resolve(directory, toPath(options.stopAt ?? root));
+	const limit = options.limit ?? Number.POSITIVE_INFINITY;
+	const paths = [name].flat();
+
+	const runMatcher = async locateOptions => {
+		if (typeof name !== 'function') {
+			return locatePath(paths, locateOptions);
+		}
+
+		const foundPath = await name(locateOptions.cwd);
+		if (typeof foundPath === 'string') {
+			return locatePath([foundPath], locateOptions);
+		}
+
+		return foundPath;
+	};
+
+	const matches = [];
+	// eslint-disable-next-line no-constant-condition
+	while (true) {
+		// eslint-disable-next-line no-await-in-loop
+		const foundPath = await runMatcher({...options, cwd: directory});
+
+		if (foundPath === findUpStop) {
+			break;
+		}
+
+		if (foundPath) {
+			matches.push(path.resolve(directory, foundPath));
+		}
+
+		if (directory === stopAt || matches.length >= limit) {
+			break;
+		}
+
+		directory = path.dirname(directory);
+	}
+
+	return matches;
+}
+
+export function findUpMultipleSync(name, options = {}) {
+	let directory = path.resolve(toPath(options.cwd) ?? '');
+	const {root} = path.parse(directory);
+	const stopAt = path.resolve(directory, toPath(options.stopAt) ?? root);
+	const limit = options.limit ?? Number.POSITIVE_INFINITY;
+	const paths = [name].flat();
+
+	const runMatcher = locateOptions => {
+		if (typeof name !== 'function') {
+			return locatePathSync(paths, locateOptions);
+		}
+
+		const foundPath = name(locateOptions.cwd);
+		if (typeof foundPath === 'string') {
+			return locatePathSync([foundPath], locateOptions);
+		}
+
+		return foundPath;
+	};
+
+	const matches = [];
+	// eslint-disable-next-line no-constant-condition
+	while (true) {
+		const foundPath = runMatcher({...options, cwd: directory});
+
+		if (foundPath === findUpStop) {
+			break;
+		}
+
+		if (foundPath) {
+			matches.push(path.resolve(directory, foundPath));
+		}
+
+		if (directory === stopAt || matches.length >= limit) {
+			break;
+		}
+
+		directory = path.dirname(directory);
+	}
+
+	return matches;
+}
+
+export async function findUp(name, options = {}) {
+	const matches = await findUpMultiple(name, {...options, limit: 1});
+	return matches[0];
+}
+
+export function findUpSync(name, options = {}) {
+	const matches = findUpMultipleSync(name, {...options, limit: 1});
+	return matches[0];
+}
+
+export {
+	pathExists,
+	pathExistsSync,
+} from 'path-exists';

handyhelpers/static/node_modules/find-up/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

handyhelpers/static/node_modules/find-up/package.json

@@ -0,0 +1,61 @@
+{
+	"name": "find-up",
+	"version": "7.0.0",
+	"description": "Find a file or directory by walking up parent directories",
+	"license": "MIT",
+	"repository": "sindresorhus/find-up",
+	"funding": "https://github.com/sponsors/sindresorhus",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "https://sindresorhus.com"
+	},
+	"type": "module",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
+	"sideEffects": false,
+	"engines": {
+		"node": ">=18"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"find",
+		"up",
+		"find-up",
+		"findup",
+		"look-up",
+		"look",
+		"file",
+		"search",
+		"match",
+		"package",
+		"resolve",
+		"parent",
+		"parents",
+		"folder",
+		"directory",
+		"walk",
+		"walking",
+		"path"
+	],
+	"dependencies": {
+		"locate-path": "^7.2.0",
+		"path-exists": "^5.0.0",
+		"unicorn-magic": "^0.1.0"
+	},
+	"devDependencies": {
+		"ava": "^5.3.1",
+		"is-path-inside": "^4.0.0",
+		"tempy": "^3.1.0",
+		"tsd": "^0.29.0",
+		"xo": "^0.56.0"
+	}
+}

handyhelpers/static/node_modules/find-up/readme.md

@@ -0,0 +1,160 @@
+# find-up
+
+> Find a file or directory by walking up parent directories
+
+## Install
+
+```sh
+npm install find-up
+```
+
+## Usage
+
+```
+/
+└── Users
+    └── sindresorhus
+        ├── unicorn.png
+        └── foo
+            └── bar
+                ├── baz
+                └── example.js
+```
+
+`example.js`
+
+```js
+import path from 'node:path';
+import {findUp, pathExists} from 'find-up';
+
+console.log(await findUp('unicorn.png'));
+//=> '/Users/sindresorhus/unicorn.png'
+
+console.log(await findUp(['rainbow.png', 'unicorn.png']));
+//=> '/Users/sindresorhus/unicorn.png'
+
+console.log(await findUp(async directory => {
+	const hasUnicorns = await pathExists(path.join(directory, 'unicorn.png'));
+	return hasUnicorns && directory;
+}, {type: 'directory'}));
+//=> '/Users/sindresorhus'
+```
+
+## API
+
+### findUp(name, options?)
+### findUp(matcher, options?)
+
+Returns a `Promise` for either the path or `undefined` if it could not be found.
+
+### findUp([...name], options?)
+
+Returns a `Promise` for either the first path found (by respecting the order of the array) or `undefined` if none could be found.
+
+### findUpMultiple(name, options?)
+### findUpMultiple(matcher, options?)
+
+Returns a `Promise` for either an array of paths or an empty array if none could be found.
+
+### findUpMultiple([...name], options?)
+
+Returns a `Promise` for either an array of the first paths found (by respecting the order of the array) or an empty array if none could be found.
+
+### findUpSync(name, options?)
+### findUpSync(matcher, options?)
+
+Returns a path or `undefined` if it could not be found.
+
+### findUpSync([...name], options?)
+
+Returns the first path found (by respecting the order of the array) or `undefined` if none could be found.
+
+### findUpMultipleSync(name, options?)
+### findUpMultipleSync(matcher, options?)
+
+Returns an array of paths or an empty array if none could be found.
+
+### findUpMultipleSync([...name], options?)
+
+Returns an array of the first paths found (by respecting the order of the array) or an empty array if none could be found.
+
+#### name
+
+Type: `string`
+
+The name of the file or directory to find.
+
+#### matcher
+
+Type: `Function`
+
+A function that will be called with each directory until it returns a `string` with the path, which stops the search, or the root directory has been reached and nothing was found. Useful if you want to match files with certain patterns, set of permissions, or other advanced use-cases.
+
+When using async mode, the `matcher` may optionally be an async or promise-returning function that returns the path.
+
+#### options
+
+Type: `object`
+
+##### cwd
+
+Type: `URL | string`\
+Default: `process.cwd()`
+
+The directory to start from.
+
+##### type
+
+Type: `string`\
+Default: `'file'`\
+Values: `'file' | 'directory'`
+
+The type of path to match.
+
+##### allowSymlinks
+
+Type: `boolean`\
+Default: `true`
+
+Allow symbolic links to match if they point to the chosen path type.
+
+##### stopAt
+
+Type: `URL | string`\
+Default: Root directory
+
+A directory path where the search halts if no matches are found before reaching this point.
+
+### pathExists(path)
+
+Returns a `Promise<boolean>` of whether the path exists.
+
+### pathExistsSync(path)
+
+Returns a `boolean` of whether the path exists.
+
+#### path
+
+Type: `string`
+
+The path to a file or directory.
+
+### findUpStop
+
+A [`Symbol`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) that can be returned by a `matcher` function to stop the search and cause `findUp` to immediately return `undefined`. Useful as a performance optimization in case the current working directory is deeply nested in the filesystem.
+
+```js
+import path from 'node:path';
+import {findUp, findUpStop} from 'find-up';
+
+await findUp(directory => {
+	return path.basename(directory) === 'work' ? findUpStop : 'logo.png';
+});
+```
+
+## Related
+
+- [find-up-cli](https://github.com/sindresorhus/find-up-cli) - CLI for this module
+- [package-up](https://github.com/sindresorhus/package-up) - Find the closest package.json file
+- [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package
+- [resolve-from](https://github.com/sindresorhus/resolve-from) - Resolve the path of a module like `require.resolve()` but from a given path