Include
class¶
Warning
The current page still doesn't have a translation for this language.
But you can help translating it: Contributing.
This is the reference for the Include
that contains all the parameters,
attributes and functions.
How to import¶
from esmerald import Include
esmerald.Include
¶
Include(path=None, app=None, name=None, routes=None, namespace=None, pattern=None, parent=None, dependencies=None, interceptors=None, permissions=None, exception_handlers=None, middleware=None, include_in_schema=True, deprecated=None, security=None, tags=None, redirect_slashes=True)
Bases: Include
Include
object class that allows scalability and modularity
to happen with elegance.
Read more about the Include to understand what can be done.
Include manages routes as a list or as a namespace but not both or a
ImproperlyConfigured
is raised.
PARAMETER | DESCRIPTION |
---|---|
path
|
Relative path of the Example
Example with parameters
TYPE:
|
app
|
An application can be anything that is treated as an ASGI application.
For example, it can be a ChildEsmerald, another The app is a parameter that makes the Include extremely powerful when it comes to integrate with ease with whatever Python stack you want and need. Example
Example with a WSGI framework
TYPE:
|
name
|
The name for the Gateway. The name can be reversed by
TYPE:
|
routes
|
A global This is also an entry-point for the routes of the Include but it does not rely on only one level. Read more about how to use and leverage the Esmerald routing system. Example
Note The Include is very powerful and this example is not enough to understand what more things you can do. Read in more detail about this.
TYPE:
|
namespace
|
A string with a qualified namespace from where the URLs should be loaded. The namespace is an alternative to The When using a Example Assuming there is a file with some routes located at myapp/auth/urls.py
Using the
TYPE:
|
pattern
|
A string By default, the when using the Example Assuming there is a file with some routes located at myapp/auth/urls.py
Using the
TYPE:
|
parent
|
Who owns the Gateway. If not specified, the application automatically it assign it. This is directly related with the application levels.
TYPE:
|
dependencies
|
A dictionary of string and Inject instances enable application level dependency injection.
TYPE:
|
interceptors
|
A list of interceptors to serve the application incoming requests (HTTP and Websockets).
TYPE:
|
permissions
|
A list of permissions to serve the application incoming requests (HTTP and Websockets).
TYPE:
|
exception_handlers
|
A dictionary of exception types (or custom exceptions) and the handler functions on an application top level. Exception handler callables should be of the form of
TYPE:
|
middleware
|
A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or Lilya Middleware as they are both converted internally. Read more about Python Protocols.
TYPE:
|
include_in_schema
|
Boolean flag indicating if it should be added to the OpenAPI docs. This will add all the routes of the Include even those nested (Include containing more Includes.)
TYPE:
|
deprecated
|
Boolean flag for indicating the deprecation of the Include and all of its routes and to display it in the OpenAPI documentation..
TYPE:
|
security
|
Used by OpenAPI definition, the security must be compliant with the norms. Esmerald offers some out of the box solutions where this is implemented. The Esmerald security is available to automatically used. The security can be applied also on a level basis. For custom security objects, you must subclass
TYPE:
|
tags
|
A list of strings tags to be applied to the path operation. It will be added to the generated OpenAPI documentation. Note almost everything in Esmerald can be done in levels, which means these tags on a Esmerald instance, means it will be added to every route even if those routes also contain tags.
TYPE:
|
redirect_slashes
|
Boolean flag indicating if the redirect slashes are enabled for the routes or not.
TYPE:
|
Source code in esmerald/routing/router.py
2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 |
|
exception_handlers
instance-attribute
¶
exception_handlers = {} if exception_handlers is None else dict(exception_handlers)
permissions
instance-attribute
¶
permissions = [permission for permission in __base_permissions__ or [] if is_esmerald_permission(permission)]