File: user-agent.md

package info (click to toggle)
python-pyfunceble 4.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,144 kB
  • sloc: python: 27,918; sh: 142; makefile: 48
file content (81 lines) | stat: -rw-r--r-- 1,658 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# `user_agent`

PyFunceble can choose a random user-agent to send when making HTTP requests. This
is how to parametrize.

## Overview

```yaml title=".PyFunceble.overwrite.yaml"
user_agent:
  # Provides everything related to choice of user agent.

  # Set the browser to pickup.
  #
  # WARNING:
  #     This parameter will be deprecated (soon?).
  #
  # Available Values: chrome, edge, firefox, ie, opera, safari
  browser: chrome

  # Set the platform to pickup.
  #
  # Available Values: linux, macosx, win10
  platform: linux

  # Set the User-Agent to use.
  #
  # WARNING:
  #     If you choose to set this argument, the browser or platform arguments
  #     won't be taken into consideration.
  #
  # CLI Argument: -ua | --user-agent
  custom: null

  # Set the reference to add to the User-Agent.
  # This is useful when you want to add a reference (e.g. a link) to the User-Agent.
  #
  # The reference will be added at the end of the User-Agent in the following format:
  # {user_agent}; +{reference}
  #
  # When set to `null`, no reference will be added.
  #
  # CLI Argument: --user-agent-reference
  reference: null
```

## `browser`

Set the browser to pickup.

**Type:** string

**Default Value:** `chrome`

**Available Values:** `chrome`, `edge`, `firefox`, `ie`, `opera`, `safari`

**CLI Argument:** None

## `platform`

Set the platform to pickup.

**Type:** string

**Default Value:** `chrome`

**Available Values:** `linux`, `macosx`, `win10`

**CLI Argument:** None

## `custom`

Set the User-Agent to use.


**Type:** string

**Default Value:** `null`

**Available Values:** User-Defined values

**CLI Argument:** `-ua`, `--user-agent`