Servant.PY

Generating python code from an API type

type PythonGenerator = [PythonRequest] -> Text

python :: HasForeign NoTypes NoContent api => Proxy api -> Foreign NoContent api

Generate the data necessary to generate Python code for all the endpoints of an API, as :<|>-separated values of type PyRequest.

pythonTyped :: HasForeign Python Text api => Proxy api -> Foreign Text api

Generate the data necessary to generate Python code for all the endpoints of an API, but try to get as much type-information into Python docstrings, in order to aid discoverability of client functions.

writePythonForAPI

Arguments

:: (HasForeign NoTypes NoContent api, GenerateList NoContent (Foreign NoContent api))

=> Proxy api

proxy for your API type

-> PythonGenerator

python code generator to use (requests is the only one for now)

-> FilePath

path to the file you want to write the resulting javascript code into

-> IO ()

Directly generate all the Python functions for your API from a Proxy for your API type using the given generator and write the resulting code to a file at the given path.

pyForAPI

Arguments

:: (HasForeign NoTypes NoContent api, GenerateList NoContent (Foreign NoContent api))

=> Proxy api

proxy for your API type

-> PythonGenerator

python code generator to use (requests is the only one for now)

-> Text

a text that you can embed in your pages or write to a file

Directly generate all the Python functions for your API from a Proxy for your API type. You can then write it to a file or integrate it in a page, for example.

pyTypedForAPI

Arguments

:: (HasForeign Python Text api, GenerateList Text (Foreign Text api))

=> Proxy api

proxy for your API type

-> PythonGenerator

python code generator to use (requests is the only one for now)

-> Text

a text that you can embed in your pages or write to a file

Directly generate all the Python functions for your API from a Proxy for your API type. You can then write it to a file or integrate it in a page, for example.

writeTypedPythonForAPI

Arguments

:: (HasForeign Python Text api, GenerateList Text (Foreign Text api))

=> Proxy api

proxy for your API type

-> PythonGenerator

python code generator to use (requests is the only one for now)

-> FilePath

path to the file you want to write the resulting javascript code into

-> IO ()

Options common to all generators

data CommonGeneratorOptions

This structure is used by specific implementations to let you customize the output

Constructors

CommonGeneratorOptions

Fields

• functionNameBuilder :: FunctionName -> Text

  function generating function names

• requestBody :: Text

  name used when a user want to send the request body (to let you redefine it)

• urlPrefix :: Text

  a prefix we should add to the Url in the codegen

• indentation :: Proxy Indent -> Text

  indentation to use for Python codeblocks. Create this function by passing an Int to indenter.

• returnMode :: ReturnStyle

  whether the generated functions return the raw response or content

defCommonGeneratorOptions :: CommonGeneratorOptions

Default options.

> defCommonGeneratorOptions = CommonGeneratorOptions
>   { functionNameBuilder = snakeCase
>   , requestBody = "body"
>   , urlPrefix = ""
>   , indentation = "    "  -- 4 spaces
>   , returnMode = DangerMode
>   }

requests :: PythonGenerator

Generate python functions that use the requests library. Uses defCommonGeneratorOptions for the generator options.

Function renamers

concatCase :: FunctionName -> Text

Function name builder that simply concat each part together

snakeCase :: FunctionName -> Text

Function name builder using the snake_case convention. each part is separated by a single underscore character.

camelCase :: FunctionName -> Text

Function name builder using the CamelCase convention. each part begins with an upper case character.

Misc.

listFromAPI :: (HasForeign k lang ftype api, GenerateList ftype (Foreign ftype api)) => Proxy k lang -> Proxy * ftype -> Proxy * api -> [Req ftype]

Generate the necessary data for codegen as a list, each Req describing one endpoint from your API type.

data NoTypes :: *

Instances

HasForeignType k * NoTypes NoContent ftype

Methods

typeFor :: Proxy NoContent ftype -> Proxy * ftype -> Proxy NoTypes a -> ftype

class GenerateList ftype reqs where

Utility class used by listFromAPI which computes the data needed to generate a function for each endpoint and hands it all back in a list.

Minimal complete definition

generateList

Methods

generateList :: reqs -> [Req ftype]

Instances

GenerateList ftype (Req ftype)

Methods

generateList :: Req ftype -> [Req ftype]

(GenerateList ftype start, GenerateList ftype rest) => GenerateList ftype ((:<|>) start rest)

Methods

generateList :: (start :<|> rest) -> [Req ftype]

newtype FunctionName :: *

Constructors

FunctionName

Fields

• unFunctionName :: [Text]

Instances

Eq FunctionName

Methods

(==) :: FunctionName -> FunctionName -> Bool

(/=) :: FunctionName -> FunctionName -> Bool

Show FunctionName

Methods

showsPrec :: Int -> FunctionName -> ShowS

show :: FunctionName -> String

showList :: [FunctionName] -> ShowS

Monoid FunctionName

Methods

mempty :: FunctionName

mappend :: FunctionName -> FunctionName -> FunctionName

mconcat :: [FunctionName] -> FunctionName