blob: 37e7a22f81c2bb4b70accf8acf594033fc8e1faa [file] [log] [blame]
Jeremy Hylton4db62b12001-02-27 19:07:02 +00001#include "Python.h"
Victor Stinner526fdeb2021-03-17 23:50:50 +01002#include "pycore_ast.h" // _PyAST_GetDocString()
Jeremy Hylton4db62b12001-02-27 19:07:02 +00003
4#define UNDEFINED_FUTURE_FEATURE "future feature %.100s is not defined"
Benjamin Petersonc0747cf2008-11-03 20:31:38 +00005#define ERR_LATE_FUTURE \
6"from __future__ imports must occur at the beginning of the file"
Jeremy Hylton4db62b12001-02-27 19:07:02 +00007
8static int
Victor Stinner14e461d2013-08-26 22:28:21 +02009future_check_features(PyFutureFeatures *ff, stmt_ty s, PyObject *filename)
Jeremy Hylton4db62b12001-02-27 19:07:02 +000010{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000011 int i;
Jeremy Hylton4db62b12001-02-27 19:07:02 +000012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000013 assert(s->kind == ImportFrom_kind);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000014
Pablo Galindoa5634c42020-09-16 19:42:00 +010015 asdl_alias_seq *names = s->v.ImportFrom.names;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000016 for (i = 0; i < asdl_seq_LEN(names); i++) {
17 alias_ty name = (alias_ty)asdl_seq_GET(names, i);
Serhiy Storchaka06515832016-11-20 09:13:07 +020018 const char *feature = PyUnicode_AsUTF8(name->name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 if (!feature)
20 return 0;
21 if (strcmp(feature, FUTURE_NESTED_SCOPES) == 0) {
22 continue;
23 } else if (strcmp(feature, FUTURE_GENERATORS) == 0) {
24 continue;
25 } else if (strcmp(feature, FUTURE_DIVISION) == 0) {
26 continue;
27 } else if (strcmp(feature, FUTURE_ABSOLUTE_IMPORT) == 0) {
28 continue;
29 } else if (strcmp(feature, FUTURE_WITH_STATEMENT) == 0) {
30 continue;
31 } else if (strcmp(feature, FUTURE_PRINT_FUNCTION) == 0) {
32 continue;
33 } else if (strcmp(feature, FUTURE_UNICODE_LITERALS) == 0) {
34 continue;
35 } else if (strcmp(feature, FUTURE_BARRY_AS_BDFL) == 0) {
36 ff->ff_features |= CO_FUTURE_BARRY_AS_BDFL;
Yury Selivanov8170e8c2015-05-09 11:44:30 -040037 } else if (strcmp(feature, FUTURE_GENERATOR_STOP) == 0) {
Yury Selivanov43c47fe2018-01-26 15:24:24 -050038 continue;
Guido van Rossum95e4d582018-01-26 08:20:18 -080039 } else if (strcmp(feature, FUTURE_ANNOTATIONS) == 0) {
Batuhan Taskaya044a1042020-10-06 23:03:02 +030040 continue;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000041 } else if (strcmp(feature, "braces") == 0) {
42 PyErr_SetString(PyExc_SyntaxError,
43 "not a chance");
Ammar Askar025eb982018-09-24 17:12:49 -040044 PyErr_SyntaxLocationObject(filename, s->lineno, s->col_offset + 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000045 return 0;
46 } else {
47 PyErr_Format(PyExc_SyntaxError,
48 UNDEFINED_FUTURE_FEATURE, feature);
Ammar Askar025eb982018-09-24 17:12:49 -040049 PyErr_SyntaxLocationObject(filename, s->lineno, s->col_offset + 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000050 return 0;
51 }
52 }
53 return 1;
Jeremy Hylton4db62b12001-02-27 19:07:02 +000054}
55
Neal Norwitz6576bd82005-11-13 18:41:28 +000056static int
Victor Stinner14e461d2013-08-26 22:28:21 +020057future_parse(PyFutureFeatures *ff, mod_ty mod, PyObject *filename)
Jeremy Hylton39e2f3f2001-02-28 01:58:08 +000058{
Benjamin Peterson2d6acd22013-03-16 09:15:47 -070059 int i, done = 0, prev_line = 0;
Jeremy Hylton39e2f3f2001-02-28 01:58:08 +000060
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000061 if (!(mod->kind == Module_kind || mod->kind == Interactive_kind))
62 return 1;
Jeremy Hylton4db62b12001-02-27 19:07:02 +000063
Benjamin Peterson2d6acd22013-03-16 09:15:47 -070064 if (asdl_seq_LEN(mod->v.Module.body) == 0)
65 return 1;
66
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067 /* A subsequent pass will detect future imports that don't
68 appear at the beginning of the file. There's one case,
69 however, that is easier to handle here: A series of imports
70 joined by semi-colons, where the first import is a future
71 statement but some subsequent import has the future form
72 but is preceded by a regular import.
73 */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000074
Serhiy Storchaka73cbe7a2018-05-29 12:04:55 +030075 i = 0;
Serhiy Storchaka143ce5c2018-05-30 10:56:16 +030076 if (_PyAST_GetDocString(mod->v.Module.body) != NULL)
Serhiy Storchaka73cbe7a2018-05-29 12:04:55 +030077 i++;
78
79 for (; i < asdl_seq_LEN(mod->v.Module.body); i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000080 stmt_ty s = (stmt_ty)asdl_seq_GET(mod->v.Module.body, i);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 if (done && s->lineno > prev_line)
83 return 1;
84 prev_line = s->lineno;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000086 /* The tests below will return from this function unless it is
87 still possible to find a future statement. The only things
88 that can precede a future statement are another future
89 statement and a doc string.
90 */
91
92 if (s->kind == ImportFrom_kind) {
Kristján Valur Jónssonc5d47d52012-03-23 12:50:53 +000093 identifier modname = s->v.ImportFrom.module;
Benjamin Petersonab79c712012-03-22 08:56:15 -040094 if (modname &&
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +020095 _PyUnicode_EqualToASCIIString(modname, "__future__")) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000096 if (done) {
97 PyErr_SetString(PyExc_SyntaxError,
98 ERR_LATE_FUTURE);
Victor Stinner14e461d2013-08-26 22:28:21 +020099 PyErr_SyntaxLocationObject(filename, s->lineno, s->col_offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 return 0;
101 }
102 if (!future_check_features(ff, s, filename))
103 return 0;
104 ff->ff_lineno = s->lineno;
105 }
Benjamin Peterson2d6acd22013-03-16 09:15:47 -0700106 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000107 done = 1;
Benjamin Peterson2d6acd22013-03-16 09:15:47 -0700108 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000109 }
Benjamin Peterson2d6acd22013-03-16 09:15:47 -0700110 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000111 done = 1;
Benjamin Peterson2d6acd22013-03-16 09:15:47 -0700112 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000113 }
114 return 1;
Jeremy Hylton4db62b12001-02-27 19:07:02 +0000115}
116
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000117
Jeremy Hylton4db62b12001-02-27 19:07:02 +0000118PyFutureFeatures *
Victor Stinner14e461d2013-08-26 22:28:21 +0200119PyFuture_FromASTObject(mod_ty mod, PyObject *filename)
Jeremy Hylton4db62b12001-02-27 19:07:02 +0000120{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000121 PyFutureFeatures *ff;
Jeremy Hylton4db62b12001-02-27 19:07:02 +0000122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000123 ff = (PyFutureFeatures *)PyObject_Malloc(sizeof(PyFutureFeatures));
124 if (ff == NULL) {
125 PyErr_NoMemory();
126 return NULL;
127 }
128 ff->ff_features = 0;
129 ff->ff_lineno = -1;
Jeremy Hylton4db62b12001-02-27 19:07:02 +0000130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000131 if (!future_parse(ff, mod, filename)) {
132 PyObject_Free(ff);
133 return NULL;
134 }
135 return ff;
Jeremy Hylton4db62b12001-02-27 19:07:02 +0000136}
Victor Stinner14e461d2013-08-26 22:28:21 +0200137
138
139PyFutureFeatures *
140PyFuture_FromAST(mod_ty mod, const char *filename_str)
141{
142 PyFutureFeatures *ff;
143 PyObject *filename;
144
145 filename = PyUnicode_DecodeFSDefault(filename_str);
146 if (filename == NULL)
147 return NULL;
148 ff = PyFuture_FromASTObject(mod, filename);
149 Py_DECREF(filename);
150 return ff;
151}