Skip to content

Latest commit

 

History

History
150 lines (91 loc) · 2.82 KB

api.rst

File metadata and controls

150 lines (91 loc) · 2.82 KB
Raw

API Reference

import math import operator import re from pydash.functions import Curry, CurryRight from pydash import *

All public functions are available from the main module.

import pydash

pydash.<function>

This is the recommended way to use pydash.

# OK (importing main module)
import pydash
pydash.where({})

# OK (import from main module)
from pydash import where
where({})

# NOT RECOMMENDED (importing from submodule)
from pydash.collections import where

Only the main pydash module API is guaranteed to adhere to semver. It's possible that backwards incompatibility outside the main module API could be broken between minor releases.

py_ Instance

There is a special py_ instance available from pydash that supports method calling and method chaining from a single object:

from pydash import py_

# Method calling
py_.initial([1, 2, 3, 4, 5]) == [1, 2, 3, 4]

# Method chaining
py_([1, 2, 3, 4, 5]).initial().value() == [1, 2, 3, 4]

# Method aliasing to underscore suffixed methods that shadow builtin names
py_.map is py_.map_
py_([1, 2, 3]).map(_.to_string).value() == py_([1, 2, 3]).map_(_.to_string).value()

The py_ instance is basically a combination of using pydash.<function> and pydash.chain.

A full listing of aliased py_ methods:

  • _.object is pydash.arrays.object_
  • _.slice is pydash.arrays.slice_
  • _.zip is pydash.arrays.zip_
  • _.all is pydash.collections.all_
  • _.any is pydash.collections.any_
  • _.filter is pydash.collections.filter_
  • _.map is pydash.collections.map_
  • _.max is pydash.collections.max_
  • _.min is pydash.collections.min_
  • _.reduce is pydash.collections.reduce_
  • _.pow is pydash.numerical.pow_
  • _.round is pydash.numerical.round_
  • _.sum is pydash.numerical.sum_
  • _.property is pydash.utilities.property_
  • _.range is pydash.utilities.range_

Arrays

pydash.arrays

Chaining

pydash.chaining

Collections

pydash.collections

Functions

pydash.functions

Numerical

pydash.numerical

Objects

pydash.objects

Predicates

pydash.predicates

Strings

pydash.strings

Utilities

pydash.utilities