pythonlib 1.0.1 → 1.0.2

package/dist/{datetime-Bpce8gG2.d.ts → datetime-BM_IjhTq.d.ts}

@@ -1,9 +1,11 @@
 /**
  * Python datetime module for TypeScript
  *
- * Provides date and time handling matching Python's datetime module.
+ * Provides date and time handling matching Python's datetime module,
+ * including date, time, datetime, and timedelta classes.
  *
  * @see {@link https://docs.python.org/3/library/datetime.html | Python datetime documentation}
+ * @module
  */
 declare class timedelta {
     readonly days: number;

package/dist/datetime.d.ts

@@ -1 +1 @@
-export { f as MAXYEAR, M as MINYEAR, a as date, c as datetime, s as strftime, e as strptime, b as time, t as timedelta } from './datetime-Bpce8gG2.js';
+export { f as MAXYEAR, M as MINYEAR, a as date, c as datetime, s as strftime, e as strptime, b as time, t as timedelta } from './datetime-BM_IjhTq.js';

package/dist/datetime.js

@@ -7,7 +7,7 @@ import {
   strptime,
   time,
   timedelta
-} from "./chunk-LWO6BIAD.js";
+} from "./chunk-OSX7QZAW.js";
 import "./chunk-PZ5AY32C.js";
 export {
   MAXYEAR,

package/dist/{functools-NrsZAqJk.d.ts → functools-uIa5g75p.d.ts}

@@ -1,9 +1,11 @@
 /**
  * Python functools module for TypeScript
  *
- * Provides higher-order functions and operations on callable objects.
+ * Provides higher-order functions and operations on callable objects,
+ * including partial application, function caching (lru_cache), and reduce.
  *
  * @see {@link https://docs.python.org/3/library/functools.html | Python functools documentation}
+ * @module
  */
 /**
  * Create a partial function application

package/dist/functools.d.ts

@@ -1 +1 @@
-export { b as attrGetter, c as cache, e as cmpToKey, d as identity, i as itemGetter, l as lruCache, m as methodCaller, p as partial, a as partialMethod, g as pipe, r as reduce, s as singleDispatch, t as totalOrdering, w as wraps } from './functools-NrsZAqJk.js';
+export { b as attrGetter, c as cache, e as cmpToKey, d as identity, i as itemGetter, l as lruCache, m as methodCaller, p as partial, a as partialMethod, g as pipe, r as reduce, s as singleDispatch, t as totalOrdering, w as wraps } from './functools-uIa5g75p.js';

package/dist/functools.js

@@ -13,7 +13,7 @@ import {
   singleDispatch,
   totalOrdering,
   wraps
-} from "./chunk-EE7SK2GV.js";
+} from "./chunk-QURVRHY2.js";
 import "./chunk-PZ5AY32C.js";
 export {
   attrGetter,

package/dist/index.d.ts

@@ -1,12 +1,12 @@
-import { i as itertoolsModule } from './itertools-Sjl1LB_0.js';
-import { f as functoolsModule } from './functools-NrsZAqJk.js';
-import { c as collectionsModule } from './collections-CJur5Wg-.js';
-import { m as mathModule } from './math-DwEGjjQ-.js';
-import { r as randomModule } from './random-BJv_rSpL.js';
-import { j as jsonModule } from './json-DAlvCadU.js';
-import { o as osModule } from './os-C6Nt7Ijx.js';
-import { d as datetimeModule } from './datetime-Bpce8gG2.js';
-import { r as reModule } from './re-B1CHCgyr.js';
+import { i as itertoolsModule } from './itertools-T0rwOk2j.js';
+import { f as functoolsModule } from './functools-uIa5g75p.js';
+import { c as collectionsModule } from './collections-BthXtkEp.js';
+import { m as mathModule } from './math-D2NPMc-x.js';
+import { r as randomModule } from './random-DcS5jtEs.js';
+import { j as jsonModule } from './json-DoWhX04T.js';
+import { o as osModule } from './os-CqGKe872.js';
+import { d as datetimeModule } from './datetime-BM_IjhTq.js';
+import { r as reModule } from './re-Bo-IOqov.js';
 import { capWords, Template } from './string.js';
 
 /**
@@ -71,138 +71,312 @@ declare function is$1(a: unknown, b: unknown): boolean;
  * @see {@link https://docs.python.org/3/library/functions.html | Python built-in functions documentation}
  */
 /**
- * Python range() function
+ * Return a sequence of numbers from start to stop (exclusive) by step.
+ *
+ * @param startOrStop - If only one argument, this is stop (start defaults to 0). Otherwise, this is start.
+ * @param stop - The end value (exclusive)
+ * @param step - The increment (default: 1)
+ * @returns An iterable of numbers
+ * @see {@link https://docs.python.org/3/library/functions.html#func-range | Python range()}
  */
 declare function range$1(startOrStop: number, stop?: number, step?: number): Iterable<number>;
 /**
- * Python enumerate() function
+ * Return an iterable of tuples containing (index, value) pairs.
+ *
+ * @param iterable - The sequence to enumerate
+ * @param start - The starting index (default: 0)
+ * @returns An iterable of [index, value] tuples
+ * @see {@link https://docs.python.org/3/library/functions.html#enumerate | Python enumerate()}
  */
 declare function enumerate$1<T>(iterable: Iterable<T>, start?: number): Iterable<[number, T]>;
 /**
- * Python zip() function
+ * Iterate over multiple iterables in parallel, yielding tuples.
+ *
+ * Stops when the shortest iterable is exhausted.
+ *
+ * @param iterables - The iterables to zip together
+ * @returns An iterable of tuples containing elements from each input
+ * @see {@link https://docs.python.org/3/library/functions.html#zip | Python zip()}
  */
 declare function zip$1<T extends unknown[][]>(...iterables: {
     [K in keyof T]: Iterable<T[K]>;
 }): Iterable<T>;
 /**
- * Safe iteration helper for for-in loops
+ * Return an iterator object for the given iterable.
+ *
+ * For objects without Symbol.iterator, returns the object's keys.
+ *
+ * @param obj - The object to iterate over
+ * @returns An iterable
+ * @see {@link https://docs.python.org/3/library/functions.html#iter | Python iter()}
  */
 declare function iter$1<T>(obj: Iterable<T> | Record<string, unknown> | null | undefined): Iterable<T> | string[];
 /**
- * Python reversed() function
+ * Return a reversed iterator over the values of the given sequence.
+ *
+ * Uses ES2023 Array.prototype.toReversed() for immutable reversal.
+ *
+ * @param iterable - The sequence to reverse
+ * @returns An iterable yielding elements in reverse order
+ * @see {@link https://docs.python.org/3/library/functions.html#reversed | Python reversed()}
  */
 declare function reversed$1<T>(iterable: Iterable<T>): Iterable<T>;
 /**
- * Python sorted() function
+ * Return a new sorted list from the items in the iterable.
+ *
+ * Uses ES2023 Array.prototype.toSorted() for immutable sorting.
+ *
+ * @param iterable - The sequence to sort
+ * @param options - Sorting options: key function and/or reverse flag
+ * @returns A new sorted array
+ * @see {@link https://docs.python.org/3/library/functions.html#sorted | Python sorted()}
  */
 declare function sorted$1<T>(iterable: Iterable<T>, options?: {
     key?: (x: T) => unknown;
     reverse?: boolean;
 }): T[];
 /**
- * Python map() function
+ * Apply a function to every item of the iterable and yield the results.
+ *
+ * Uses ES2024 Iterator.prototype.map() for lazy evaluation.
+ *
+ * @param fn - The function to apply to each element
+ * @param iterable - The input iterable
+ * @returns An iterable of transformed values
+ * @see {@link https://docs.python.org/3/library/functions.html#map | Python map()}
  */
 declare function map$1<T, U>(fn: (x: T) => U, iterable: Iterable<T>): Iterable<U>;
 /**
- * Python filter() function
+ * Return an iterable yielding items where the function returns true.
+ *
+ * If function is null, return items that are truthy.
+ * Uses ES2024 Iterator.prototype.filter() for lazy evaluation.
+ *
+ * @param fn - The predicate function (or null for truthiness check)
+ * @param iterable - The input iterable
+ * @returns An iterable of filtered values
+ * @see {@link https://docs.python.org/3/library/functions.html#filter | Python filter()}
  */
 declare function filter$1<T>(fn: ((x: T) => boolean) | null, iterable: Iterable<T>): Iterable<T>;
 /**
- * Create a tuple (readonly array)
+ * Create an immutable tuple (frozen array).
+ *
+ * @param items - The elements to include in the tuple
+ * @returns A frozen (readonly) array
+ * @see {@link https://docs.python.org/3/library/functions.html#func-tuple | Python tuple()}
  */
 declare function tuple$1<T extends unknown[]>(...items: T): Readonly<T>;
 /**
- * Python len() function
+ * Return the number of items in an object.
+ *
+ * Works with strings, arrays, Maps, Sets, and objects with a length property.
+ *
+ * @param obj - The object to measure
+ * @returns The number of items
+ * @see {@link https://docs.python.org/3/library/functions.html#len | Python len()}
  */
 declare function len$1(obj: string | unknown[] | Map<unknown, unknown> | Set<unknown> | {
     length: number;
 }): number;
 /**
- * Python abs() function
+ * Return the absolute value of a number.
+ *
+ * @param x - The number
+ * @returns The absolute value
+ * @see {@link https://docs.python.org/3/library/functions.html#abs | Python abs()}
  */
 declare function abs$1(x: number): number;
 /**
- * Python min() function
+ * Return the smallest item in an iterable or the smallest of two or more arguments.
+ *
+ * @param args - An iterable, or multiple values to compare
+ * @returns The minimum value
+ * @see {@link https://docs.python.org/3/library/functions.html#min | Python min()}
  */
 declare function min$1<T>(...args: T[] | [Iterable<T>]): T;
 /**
- * Python max() function
+ * Return the largest item in an iterable or the largest of two or more arguments.
+ *
+ * @param args - An iterable, or multiple values to compare
+ * @returns The maximum value
+ * @see {@link https://docs.python.org/3/library/functions.html#max | Python max()}
  */
 declare function max$1<T>(...args: T[] | [Iterable<T>]): T;
 /**
- * Python sum() function
+ * Return the sum of all items in the iterable plus an optional start value.
+ *
+ * @param iterable - The numbers to sum
+ * @param start - The initial value (default: 0)
+ * @returns The sum
+ * @see {@link https://docs.python.org/3/library/functions.html#sum | Python sum()}
  */
 declare function sum$1(iterable: Iterable<number>, start?: number): number;
 /**
- * Python all() function
+ * Return True if all elements of the iterable are truthy (or if empty).
+ *
+ * @param iterable - The elements to test
+ * @returns True if all elements are truthy
+ * @see {@link https://docs.python.org/3/library/functions.html#all | Python all()}
  */
 declare function all$1(iterable: Iterable<unknown>): boolean;
 /**
- * Python any() function
+ * Return True if any element of the iterable is truthy.
+ *
+ * @param iterable - The elements to test
+ * @returns True if any element is truthy
+ * @see {@link https://docs.python.org/3/library/functions.html#any | Python any()}
  */
 declare function any$1(iterable: Iterable<unknown>): boolean;
 /**
- * Python round() function
+ * Round a number to a given precision in decimal digits.
+ *
+ * Uses banker's rounding (round half to even) for values exactly halfway.
+ *
+ * @param number - The number to round
+ * @param ndigits - Number of decimal places (default: 0)
+ * @returns The rounded number
+ * @see {@link https://docs.python.org/3/library/functions.html#round | Python round()}
  */
 declare function round$1(number: number, ndigits?: number): number;
 /**
- * Python ord()
+ * Return the Unicode code point for a one-character string.
+ *
+ * @param char - A single character
+ * @returns The Unicode code point
+ * @see {@link https://docs.python.org/3/library/functions.html#ord | Python ord()}
  */
 declare function ord$1(char: string): number;
 /**
- * Python chr()
+ * Return the string representing a character at the given Unicode code point.
+ *
+ * @param code - The Unicode code point
+ * @returns A single-character string
+ * @see {@link https://docs.python.org/3/library/functions.html#chr | Python chr()}
  */
 declare function chr$1(code: number): string;
 /**
- * Python hex()
+ * Convert an integer to a lowercase hexadecimal string prefixed with "0x".
+ *
+ * @param x - The integer to convert
+ * @returns Hexadecimal string (e.g., "0xff")
+ * @see {@link https://docs.python.org/3/library/functions.html#hex | Python hex()}
  */
 declare function hex$1(x: number): string;
 /**
- * Python oct()
+ * Convert an integer to an octal string prefixed with "0o".
+ *
+ * @param x - The integer to convert
+ * @returns Octal string (e.g., "0o17")
+ * @see {@link https://docs.python.org/3/library/functions.html#oct | Python oct()}
  */
 declare function oct$1(x: number): string;
 /**
- * Python bin()
+ * Convert an integer to a binary string prefixed with "0b".
+ *
+ * @param x - The integer to convert
+ * @returns Binary string (e.g., "0b1010")
+ * @see {@link https://docs.python.org/3/library/functions.html#bin | Python bin()}
  */
 declare function bin$1(x: number): string;
 /**
- * Python int() function
+ * Convert a value to an integer.
+ *
+ * Truncates floats toward zero. Parses strings in the given base.
+ *
+ * @param x - The value to convert
+ * @param base - The base for string conversion (default: 10)
+ * @returns The integer value
+ * @see {@link https://docs.python.org/3/library/functions.html#int | Python int()}
  */
 declare function int$1(x: string | number | boolean, base?: number): number;
 /**
- * Python float() function
+ * Convert a value to a floating-point number.
+ *
+ * @param x - The value to convert
+ * @returns The float value
+ * @see {@link https://docs.python.org/3/library/functions.html#float | Python float()}
  */
 declare function float$1(x: string | number): number;
 /**
- * Python str() function
+ * Convert a value to its string representation.
+ *
+ * Uses Python-style formatting for booleans (True/False), None, and collections.
+ *
+ * @param x - The value to convert
+ * @returns The string representation
+ * @see {@link https://docs.python.org/3/library/functions.html#func-str | Python str()}
  */
 declare function str$1(x: unknown): string;
 /**
- * Python repr() function
+ * Return a string containing a printable representation of an object.
+ *
+ * Strings are quoted, other types use str() representation.
+ *
+ * @param x - The value to represent
+ * @returns A printable representation
+ * @see {@link https://docs.python.org/3/library/functions.html#repr | Python repr()}
  */
 declare function repr$1(x: unknown): string;
 /**
- * Python bool() function
+ * Convert a value to a boolean using Python's truthiness rules.
+ *
+ * False values: null, undefined, false, 0, empty strings, empty arrays, empty Maps/Sets.
+ *
+ * @param x - The value to convert
+ * @returns The boolean value
+ * @see {@link https://docs.python.org/3/library/functions.html#bool | Python bool()}
  */
 declare function bool$1(x: unknown): boolean;
 /**
- * Python ascii() - returns ASCII representation
+ * Return a string containing a printable ASCII representation.
+ *
+ * Non-ASCII characters are escaped using \\xhh, \\uhhhh, or \\Uhhhhhhhh.
+ *
+ * @param x - The value to represent
+ * @returns ASCII-safe printable representation
+ * @see {@link https://docs.python.org/3/library/functions.html#ascii | Python ascii()}
  */
 declare function ascii$1(x: unknown): string;
 /**
- * Python isinstance() - simplified version
+ * Return True if the object is an instance of the specified class.
+ *
+ * Supports JavaScript constructors (Number, String, etc.) and Python type names.
+ *
+ * @param obj - The object to check
+ * @param classInfo - The class or type name to check against
+ * @returns True if obj is an instance of classInfo
+ * @see {@link https://docs.python.org/3/library/functions.html#isinstance | Python isinstance()}
  */
 declare function isinstance$1(obj: unknown, classInfo: unknown): boolean;
 /**
- * Python type() - simplified version
+ * Return the type name of an object as a string.
+ *
+ * Returns Python-style type names: 'int', 'float', 'str', 'bool', 'list', 'dict', 'set'.
+ *
+ * @param obj - The object to check
+ * @returns The type name
+ * @see {@link https://docs.python.org/3/library/functions.html#type | Python type()}
  */
 declare function type$1(obj: unknown): string;
 /**
- * Python input() - for Node.js
+ * Read a line of input from the user.
+ *
+ * Note: This function requires async implementation in JavaScript environments.
+ *
+ * @param prompt - Optional prompt string to display
+ * @returns The input string
+ * @see {@link https://docs.python.org/3/library/functions.html#input | Python input()}
  */
 declare function input$1(prompt?: string): string;
 /**
- * Python format() - formats a value according to format spec
+ * Convert a value to a formatted representation using a format specification.
+ *
+ * Supports Python format spec mini-language for numbers and strings.
+ *
+ * @param value - The value to format
+ * @param spec - The format specification string
+ * @returns The formatted string
+ * @see {@link https://docs.python.org/3/library/functions.html#format | Python format()}
  */
 declare function format$1(value: unknown, spec: string): string;
 /**
@@ -344,6 +518,8 @@ declare const dict$1: {
 /**
  * Python set methods for TypeScript
  * Usage: py.set.intersection(), py.set.union(), etc.
+ *
+ * Uses ES2024 native Set methods where available for optimal performance.
  */
 declare const set$1: {
     /**
@@ -376,10 +552,12 @@ declare const set$1: {
     update<T>(s: Set<T>, ...iterables: Iterable<T>[]): void;
     /**
      * Python set.union() - returns new set with all elements
+     * Uses ES2024 Set.prototype.union()
      */
     union<T>(a: Set<T>, ...others: Iterable<T>[]): Set<T>;
     /**
      * Python set.intersection() - returns new set with common elements
+     * Uses ES2024 Set.prototype.intersection()
      */
     intersection<T>(a: Set<T>, b: Set<T>): Set<T>;
     /**
@@ -388,6 +566,7 @@ declare const set$1: {
     intersectionUpdate<T>(a: Set<T>, b: Set<T>): void;
     /**
      * Python set.difference() - returns new set with elements in a but not in b
+     * Uses ES2024 Set.prototype.difference()
      */
     difference<T>(a: Set<T>, b: Set<T>): Set<T>;
     /**
@@ -396,43 +575,54 @@ declare const set$1: {
     differenceUpdate<T>(a: Set<T>, b: Set<T>): void;
     /**
      * Python set.symmetric_difference() - returns new set with elements in either but not both
+     * Uses ES2024 Set.prototype.symmetricDifference()
      */
     symmetricDifference<T>(a: Set<T>, b: Set<T>): Set<T>;
     /**
      * Python set.symmetric_difference_update() - update with symmetric difference
+     * Uses ES2024 Set.prototype.symmetricDifference()
      */
     symmetricDifferenceUpdate<T>(a: Set<T>, b: Set<T>): void;
     /**
      * Python set.isSubset() - test if all elements are in other
+     * Uses ES2024 Set.prototype.isSubsetOf()
      */
     isSubset<T>(a: Set<T>, b: Set<T>): boolean;
     /**
      * Python set.isSuperset() - test if all other elements are in this set
+     * Uses ES2024 Set.prototype.isSupersetOf()
      */
     isSuperset<T>(a: Set<T>, b: Set<T>): boolean;
     /**
      * Python set.isDisjoint() - test if no common elements
+     * Uses ES2024 Set.prototype.isDisjointFrom()
      */
     isDisjoint<T>(a: Set<T>, b: Set<T>): boolean;
 };
 
 /**
- * Python Runtime Library for TypeScript
+ * Python Built-in Functions for TypeScript
+ *
+ * This module provides Python's built-in functions that are always available
+ * without imports. These are the fundamental operations for working with data
+ * in Python, including iteration (range, enumerate, zip), aggregation (len,
+ * sum, min, max), type conversion (int, str, bool), and more.
  *
- * Import styles:
+ * @example
+ * ```typescript
+ * // Direct imports
+ * import { len, range, sorted, min, max } from "pythonlib"
  *
- * 1. Builtins (global Python functions):
- *    import { len, range, sorted, min, max } from "pythonlib"
+ * // Module imports (like Python)
+ * import { chain, combinations } from "pythonlib/itertools"
+ * import { Counter, defaultdict } from "pythonlib/collections"
  *
- * 2. Module imports (like Python):
- *    import { dump, loads } from "pythonlib/json"
- *    import { match, search, sub } from "pythonlib/re"
- *    import { chain, combinations } from "pythonlib/itertools"
- *    import { Counter, defaultdict } from "pythonlib/collections"
+ * // Module namespaces
+ * import { json, re, itertools } from "pythonlib"
+ * ```
  *
- * 3. Module namespaces (alternative):
- *    import { json, re, itertools } from "pythonlib"
- *    json.dump(...), re.match(...), itertools.chain(...)
+ * @see {@link https://docs.python.org/3/library/functions.html | Python Built-in Functions}
+ * @module
  */
 
 declare const itertools: typeof itertoolsModule;