Skip to content

# Code References

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

## `get_complements(subject, include_given=False)`

Provides the complements of a given subject.

A complement is a for example :code:`example.org` if :code:`www.example.org` is given and vice-versa.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import Subject2Complements

        my_subject = "example.org"
        complements = Subject2Complements(
            my_subject
        ).get_converted(include_given=True)

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required
`include_given` | `bool` | Include the given subject in the result. | `False`

Source code in `PyFunceble/__init__.py`

    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760

    def get_complements(subject: str, include_given: bool = False) -> List[str]:
        """
        Provides the complements of a given subject.

        A complement is a for example :code:`example.org` if :code:`www.example.org`
        is given and vice-versa.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import Subject2Complements

                my_subject = "example.org"
                complements = Subject2Complements(
                    my_subject
                ).get_converted(include_given=True)

        :param subject:
            The subject to work with.

        :param include_given:
            Include the given subject in the result.
        """

        warnings.warn(
            "PyFunceble.get_complements may be removed in the future."
            "Please consider using PyFunceble.Subject2Complements explicitly",
            DeprecationWarning,
        )

        return Subject2Complements(subject, include_given=include_given).get_converted()

## `is_domain(subject, **kwargs)`

Checks if the given subject is a syntactically valid second level domain or subdomain.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import DomainSyntaxChecker

        my_subject = "example.org"
        the_status = DomainSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is a domain (2nd level or subdomain).
        print(f"{my_subject} is domain ? {the_status.is_valid()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267

    def is_domain(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid second level domain
        or subdomain.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import DomainSyntaxChecker

                my_subject = "example.org"
                the_status = DomainSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is a domain (2nd level or subdomain).
                print(f"{my_subject} is domain ? {the_status.is_valid()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_domain may be removed in the future."
            "Please consider using PyFunceble.DomainSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return DomainSyntaxChecker(subject, **kwargs).is_valid()

## `is_domain_malicious(subject, **kwargs)`

Checks if the given domain is malicious.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import DomainReputationChecker

        my_subject = "example.org"
        the_status = DomainReputationChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is malicious.
        print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638

    def is_domain_malicious(subject: str, **kwargs) -> bool:
        """
        Checks if the given domain is malicious.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import DomainReputationChecker

                my_subject = "example.org"
                the_status = DomainReputationChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is malicious.
                print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_domain_malicious may be removed in the future."
            "Please consider using PyFunceble.DomainReputationChecker explicitly.",
            DeprecationWarning,
        )

        # pylint: disable=no-member
        return DomainReputationChecker(subject, **kwargs).get_status().is_malicious()

## `is_ip(subject, **kwargs)`

Checks if the given subject is a syntactically valid IP range.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import IPSyntaxChecker

        my_subject = "192.168.0.0"
        the_status = IPSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is an IP (v4 or v6).
        print(f"{my_subject} is IP ? {the_status.is_valid()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349

    def is_ip(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid IP range.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import IPSyntaxChecker

                my_subject = "192.168.0.0"
                the_status = IPSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is an IP (v4 or v6).
                print(f"{my_subject} is IP ? {the_status.is_valid()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_ip may be removed in the future."
            "Please consider using PyFunceble.IPSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return IPSyntaxChecker(subject, **kwargs).is_valid()

## `is_ip_range(subject, **kwargs)`

Checks if the given subject is a syntactically valid IP range.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import IPSyntaxChecker

        my_subject = "192.168.0.0"
        the_status = IPSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is an IP range (v4 or v6).
        print(f"{my_subject} is IP range ? {the_status.is_valid_range()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472

    def is_ip_range(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid IP range.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import IPSyntaxChecker

                my_subject = "192.168.0.0"
                the_status = IPSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is an IP range (v4 or v6).
                print(f"{my_subject} is IP range ? {the_status.is_valid_range()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_ip_range may be removed in the future."
            "Please consider using PyFunceble.IPSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return IPSyntaxChecker(subject, **kwargs).is_valid_range()

## `is_ipv4(subject, **kwargs)`

Checks if the given subject is a syntactically valid IPv4.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import IPSyntaxChecker

        my_subject = "192.168.0.0"
        the_status = IPSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is an IPv4.
        print(f"{my_subject} is IPv4 ? {the_status.is_valid_v4()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390

    def is_ipv4(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid IPv4.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import IPSyntaxChecker

                my_subject = "192.168.0.0"
                the_status = IPSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is an IPv4.
                print(f"{my_subject} is IPv4 ? {the_status.is_valid_v4()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_ipv4 be removed in the future."
            "Please consider using PyFunceble.IPSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return IPSyntaxChecker(subject, **kwargs).is_valid_v4()

## `is_ipv4_malicious(subject, **kwargs)`

Checks if the given IPv4 is malicious.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import IPReputationChecker

        my_subject = "192.168.0.1"
        the_status = IPReputationChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is malicious.
        print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680

    def is_ipv4_malicious(subject: str, **kwargs) -> bool:
        """
        Checks if the given IPv4 is malicious.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import IPReputationChecker

                my_subject = "192.168.0.1"
                the_status = IPReputationChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is malicious.
                print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_ipv4_malicious may be removed in the future."
            "Please consider using PyFunceble.IPReputationChecker explicitly.",
            DeprecationWarning,
        )

        # pylint: disable=no-member
        return IPReputationChecker(subject, **kwargs).get_status().is_malicious()

## `is_ipv4_range(subject, **kwargs)`

Checks if the given subject is a syntactically valid IPv4 range.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import IPSyntaxChecker

        my_subject = "192.168.0.0"
        the_status = IPSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is IPv4 range.
        print(f"{my_subject} is IPv4 range ? {the_status.is_valid_v4_range()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513

    def is_ipv4_range(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid IPv4 range.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import IPSyntaxChecker

                my_subject = "192.168.0.0"
                the_status = IPSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is IPv4 range.
                print(f"{my_subject} is IPv4 range ? {the_status.is_valid_v4_range()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_ipv4_range may be removed in the future."
            "Please consider using PyFunceble.IPSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return IPSyntaxChecker(subject, **kwargs).is_valid_v4_range()

## `is_ipv6(subject, **kwargs)`

Checks if the given subject is a syntactically valid IPv6.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import IPSyntaxChecker

        my_subject = "192.168.0.0"
        the_status = IPSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is an IPv6.
        print(f"{my_subject} is IPv6 ? {the_status.is_valid_v6()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431

    def is_ipv6(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid IPv6.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import IPSyntaxChecker

                my_subject = "192.168.0.0"
                the_status = IPSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is an IPv6.
                print(f"{my_subject} is IPv6 ? {the_status.is_valid_v6()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_ipv6 be removed in the future."
            "Please consider using PyFunceble.IPSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return IPSyntaxChecker(subject, **kwargs).is_valid_v6()

## `is_ipv6_range(subject, **kwargs)`

Checks if the given subject is a syntactically valid IPv6 range.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import IPSyntaxChecker

        my_subject = "::1"
        the_status = IPSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is IPv6 range.
        print(f"{my_subject} is IPv6 range ? {the_status.is_valid_v6_range()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554

    def is_ipv6_range(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid IPv6 range.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import IPSyntaxChecker

                my_subject = "::1"
                the_status = IPSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is IPv6 range.
                print(f"{my_subject} is IPv6 range ? {the_status.is_valid_v6_range()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_ipv6_range may be removed in the future."
            "Please consider using PyFunceble.IPSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return IPSyntaxChecker(subject, **kwargs).is_valid_v6_range()

## `is_second_level_domain(subject, **kwargs)`

Checks if the given subject is a syntactically valid second level domain.

.. warning:: This method was added for retrocompatibility. It may be removed in the future and is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import SecondLvlDomainSyntaxChecker

        my_subject = "example.org"
        the_status = SecondLvlDomainSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is a second level domain.
        print(f"{my_subject} is 2nd level domain ? {the_status.is_valid()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225

    def is_second_level_domain(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid second level domain.

        .. warning::
            This method was added for retrocompatibility.
            It may be removed in the future and is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import SecondLvlDomainSyntaxChecker

                my_subject = "example.org"
                the_status = SecondLvlDomainSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is a second level domain.
                print(f"{my_subject} is 2nd level domain ? {the_status.is_valid()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_second_level_domain was added for retro compatibility. "
            "It may be removed in the future."
            "Please consider using PyFunceble.SecondLvlDomainSyntaxChecker explicitly.",
        )

        return SecondLvlDomainSyntaxChecker(subject, **kwargs).is_valid()

## `is_subdomain(subject, **kwargs)`

Checks if the given subject is a syntactically valid subdomain.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import SubDomainSyntaxChecker

        my_subject = "hello.example.org"
        the_status = SubDomainSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is a subdomain.
        print(f"{my_subject} is subdomain ? {the_status.is_valid()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308

    def is_subdomain(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is a syntactically valid subdomain.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import SubDomainSyntaxChecker

                my_subject = "hello.example.org"
                the_status = SubDomainSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is a subdomain.
                print(f"{my_subject} is subdomain ? {the_status.is_valid()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_subdomain may be removed in the future."
            "Please consider using PyFunceble.SubDomainSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        return SubDomainSyntaxChecker(subject, **kwargs).is_valid()

## `is_url(subject, **kwargs)`

Checks if the given subject is syntactically a valid URL.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import DomainReputationChecker

        my_subject = "https://example.org"
        the_status = URLSyntaxChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is a URL.
        print(f"{my_subject} is URL ? {the_status.is_valid()}")

:parma subject: The subject to check.

Source code in `PyFunceble/__init__.py`

    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596

    def is_url(subject: str, **kwargs) -> bool:
        """
        Checks if the given subject is syntactically a valid URL.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import DomainReputationChecker

                my_subject = "https://example.org"
                the_status = URLSyntaxChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is a URL.
                print(f"{my_subject} is URL ? {the_status.is_valid()}")

        :parma subject:
            The subject to check.
        """

        warnings.warn(
            "PyFunceble.is_url may be removed in the future."
            "Please consider using PyFunceble.URLSyntaxChecker explicitly.",
            DeprecationWarning,
        )

        # pylint: disable=no-member
        return URLSyntaxChecker(subject, **kwargs).get_status().is_valid()

## `is_url_malicious(subject, **kwargs)`

Checks if the given URL is malicious.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import URLReputationChecker

        my_subject = "https://example.org"
        the_status = URLReputationChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is malicious.
        print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722

    def is_url_malicious(subject: str, **kwargs) -> bool:
        """
        Checks if the given URL is malicious.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import URLReputationChecker

                my_subject = "https://example.org"
                the_status = URLReputationChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is malicious.
                print(f"{my_subject} is Malicious ? {the_status.is_malicious()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.is_url_malicious may be removed in the future."
            "Please consider using PyFunceble.URLReputationChecker explicitly.",
            DeprecationWarning,
        )

        # pylint: disable=no-member
        return URLReputationChecker(subject, **kwargs).get_status().is_malicious()

## `load_config(*args, **kwargs)`

Placeholder before deletion.

Since 4.0.0, you are not required to load the configuration before hand. If you still want too because you may want to use a special CLI related method, you can doing it so:

::

    import PyFunceble.facility

    PyFunceble.facility.ConfigLoader.start()

Source code in `PyFunceble/__init__.py`

     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101

    def load_config(*args, **kwargs) -> None:
        """
        Placeholder before deletion.

        Since 4.0.0, you are not required to load the configuration before hand.
        If you still want too because you may want to use a special CLI related
        method, you can doing it so:

        ::

            import PyFunceble.facility

            PyFunceble.facility.ConfigLoader.start()
        """

        warnings.warn(
            "PyFunceble.load_config may be removed in the future."
            "As of today, because the configuration is not necessary (anymore), "
            "this method does nothing. Consider it a placeholder.I"
            "Please consider using PyFunceble.facility.ConfigLoader.start instead.",
            DeprecationWarning,
        )

        _, _ = args, kwargs

## `test(subject, **kwargs)`

Checks the avaialbility of the given subject assuming that it is a domain or an IP.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import DomainAndIPAvailabilityChecker

        my_subject = "example.org"
        the_status = DomainAndIPAvailabilityChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is available.
        print(f"{my_subject} is available ? {the_status.is_available()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143

    def test(subject: str, **kwargs) -> AvailabilityCheckerStatus:
        """
        Checks the avaialbility of the given subject assuming that it is a domain
        or an IP.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import DomainAndIPAvailabilityChecker

                my_subject = "example.org"
                the_status = DomainAndIPAvailabilityChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is available.
                print(f"{my_subject} is available ? {the_status.is_available()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.test may be removed in the future."
            "Please consider using PyFunceble.DomainAndIPAvailabilityChecker explicitly.",
            DeprecationWarning,
        )

        return DomainAndIPAvailabilityChecker(subject, **kwargs).get_status()

## `url_test(subject, **kwargs)`

Checks the availability of the given subject assuming that it is a URL.

.. warning:: This method may be removed in the future. It is still available for convenience.

    Please consider the following alternative example:

    ::

        from PyFunceble import URLAvailabilityChecker

        my_subject = "http://example.org"
        the_status = URLAvailabilityChecker(
            my_subject
        ).get_status()

        # Get the status in dict format.
        print(the_status.to_dict())

        # Get the status in json format.
        print(the_status.to_json())

        # Check if it is available.
        print(f"{my_subject} is available ? {the_status.is_available()}")

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`subject` | `str` | The subject to work with. | required

Source code in `PyFunceble/__init__.py`

    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184

    def url_test(subject: str, **kwargs) -> AvailabilityCheckerStatus:
        """
        Checks the availability of the given subject assuming that it is a URL.

        .. warning::
            This method may be removed in the future.
            It is still available for convenience.

            Please consider the following alternative example:

            ::

                from PyFunceble import URLAvailabilityChecker

                my_subject = "http://example.org"
                the_status = URLAvailabilityChecker(
                    my_subject
                ).get_status()

                # Get the status in dict format.
                print(the_status.to_dict())

                # Get the status in json format.
                print(the_status.to_json())

                # Check if it is available.
                print(f"{my_subject} is available ? {the_status.is_available()}")

        :param subject:
            The subject to work with.
        """

        warnings.warn(
            "PyFunceble.test may be removed in the future."
            "Please consider using PyFunceble.URLAvailabilityChecker explicitly.",
            DeprecationWarning,
        )

        return URLAvailabilityChecker(subject, **kwargs).get_status()